56 lines
1.8 KiB
Markdown
56 lines
1.8 KiB
Markdown
|
# CLAUDE.md
|
||
|
|
|
||
|
|
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
|
||
|
|
|
||
|
|
## Project Overview
|
||
|
|
|
||
|
|
This is a Claude Code Skills repository containing two main components:
|
||
|
|
1. **FileSystem MCP Server** (`filesystem-mcp-server/`) - A Model Context Protocol server implementation in TypeScript
|
||
|
|
2. **Claude Skills** (`.claude/skills/`) - 16 modular skills that extend Claude's capabilities
|
||
|
|
|
||
|
|
## Build Commands
|
||
|
|
|
||
|
|
All commands run from `filesystem-mcp-server/` directory:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
# Build the TypeScript MCP server
|
||
|
|
npm run build
|
||
|
|
|
||
|
|
# Development mode with hot reload
|
||
|
|
npm run dev
|
||
|
|
|
||
|
|
# Start the server (after build)
|
||
|
|
npm start
|
||
|
|
|
||
|
|
# Clean build artifacts
|
||
|
|
npm run clean
|
||
|
|
```
|
||
|
|
|
||
|
|
**Environment Variables:**
|
||
|
|
- `TRANSPORT` - Transport mode (`stdio` or `http`, default: `http`)
|
||
|
|
- `PORT` - HTTP port (default: `3000`)
|
||
|
|
|
||
|
|
## Architecture
|
||
|
|
|
||
|
|
### MCP Server (`filesystem-mcp-server/`)
|
||
|
|
- **Transport**: Dual support (stdio for local, HTTP for remote)
|
||
|
|
- **Entry point**: `src/index.ts` - handles transport selection
|
||
|
|
- **Tools**: Modular pattern in `src/tools/` - each tool in its own file
|
||
|
|
- **Validation**: Zod schemas for all tool inputs
|
||
|
|
- **Type safety**: Strict TypeScript with `src/types.ts` and `src/constants.ts`
|
||
|
|
|
||
|
|
### Skills (`.claude/skills/`)
|
||
|
|
Each skill follows a standard structure:
|
||
|
|
- `SKILL.md` - Main documentation with YAML frontmatter (`name`, `description`)
|
||
|
|
- Optional: `scripts/`, `references/`, `assets/` folders
|
||
|
|
- Most skills reference Python libraries (pypdf, reportlab, python-pptx, openpyxl, etc.)
|
||
|
|
|
||
|
|
## Key Skills
|
||
|
|
- `mcp-builder` - Guides creating MCP servers with TypeScript/Python SDKs
|
||
|
|
- `skill-creator` - Guides creating new skills (6-step process)
|
||
|
|
|
||
|
|
## Important Notes
|
||
|
|
- No `package.json` at root - each component is separate
|
||
|
|
- MCP server uses ES modules (`"type": "module"`)
|
||
|
|
- No existing Cursor/Copilot rules files
|