Docs Package
CLI & Project Scaffolding
Scaffolding a ready-to-run documentation MCP server project with the CLI tool
CLI & Project Scaffolding
@mcpframework/docs includes a CLI tool that scaffolds a ready-to-run documentation MCP server project.
Creating a Project
npx create-docs-mcp my-api-docsThis creates a project with the following structure:
my-api-docs/
├── src/
│ └── index.ts # Pre-configured DocsServer with FumadocsRemoteSource
├── package.json # Dependencies on mcp-framework + @mcpframework/docs
├── tsconfig.json # TypeScript configuration
├── .env.example # DOCS_BASE_URL, optional DOCS_API_KEY
├── .gitignore
└── README.md # Setup instructions and MCP client configGenerated Files
src/index.ts
import { DocsServer, FumadocsRemoteSource } from "@mcpframework/docs";
const source = new FumadocsRemoteSource({
baseUrl: process.env.DOCS_BASE_URL || "https://docs.example.com",
headers: process.env.DOCS_API_KEY
? { Authorization: `Bearer ${process.env.DOCS_API_KEY}` }
: undefined,
});
const server = new DocsServer({
source,
name: process.env.DOCS_SERVER_NAME || "my-api-docs",
version: "1.0.0",
});
server.start();.env.example
DOCS_BASE_URL=https://docs.example.com
DOCS_SERVER_NAME=my-api-docs
# DOCS_API_KEY=your-api-key-hereSetup After Scaffolding
cd my-api-docs
cp .env.example .env
# Edit .env with your documentation site URL
npm run build
npm startConnecting to MCP Clients
Claude Code
claude mcp add my-api-docs -- node /path/to/my-api-docs/dist/index.jsClaude Desktop
Add to claude_desktop_config.json:
{
"mcpServers": {
"my-api-docs": {
"command": "node",
"args": ["/path/to/my-api-docs/dist/index.js"],
"env": {
"DOCS_BASE_URL": "https://docs.myapi.com"
}
}
}
}Cursor
Add to MCP settings:
{
"my-api-docs": {
"command": "node",
"args": ["/path/to/my-api-docs/dist/index.js"],
"env": {
"DOCS_BASE_URL": "https://docs.myapi.com"
}
}
}SKILL.md Template
The package includes a SKILL.md.template that you can customize to teach Claude Code how to approach integrations against your API. Copy it into your project:
cp node_modules/@mcpframework/docs/SKILL.md.template SKILL.md
# Edit SKILL.md with your API-specific patternsThe template includes <!-- CUSTOMIZE --> markers for sections you should edit:
- Authentication patterns
- SDK initialization
- Common API call patterns
- Error handling
- Common pitfalls