scaffold-mcp-server
关于
This skill scaffolds a complete, runnable MCP server project from a tool specification using the official TypeScript or Python SDK. It generates the proper project structure, transport configuration, tool handlers, and a test harness. Use it when you have a spec and need a working server, are starting a new MCP project, migrating an existing integration, or prototyping a tool surface.
快速安装
Claude Code
推荐npx skills add pjt222/agent-almanac -a claude-code/plugin add https://github.com/pjt222/agent-almanacgit clone https://github.com/pjt222/agent-almanac.git ~/.claude/skills/scaffold-mcp-server在 Claude Code 中复制并粘贴此命令以安装该技能
技能文档
Scaffold MCP Server
Generate runnable MCP server project from tool spec → official MCP SDK (TS|Py).
Use When
- Have spec (from
analyze-codebase-for-mcpor manual) + need server - New MCP project → right structure from start
- Migrate existing tool integ → MCP protocol
- Prototype tool surface → test w/ Claude Code pre-full-impl
- Need scaffold + test harness for CI
In
- Required: Tool spec doc (YAML|JSON: tool names, params, return types)
- Required: Lang (
typescript|python) - Required: Transport (
stdio|sse) - Optional: Output dir (default: cwd)
- Optional: Pkg name + ver
- Optional: Auth (
none|bearer-token|api-key) - Optional: Docker (
true|false, defaultfalse)
Do
Step 1: SDK Lang + Transport
1.1. Lang by ctx:
- TS: Node.js, web-adj, JSON-heavy
- Py: Data sci, ML, scientific tools
1.2. Transport:
- stdio: Default local. Claude Code launches as subprocess.
- SSE: Remote|shared. Needs HTTP host.
1.3. Auth:
- none: Local stdio (proc-level trust)
- bearer-token: Remote SSE w/ static tokens
- api-key: Remote w/ per-client keys
→ Lang, transport, auth documented.
If err: ambiguous → default TS + stdio + no auth → fastest time-to-working.
Step 2: Init Project
2.1. Mkdir + init:
TS:
mkdir -p $PROJECT_NAME && cd $PROJECT_NAME
npm init -y
npm install @modelcontextprotocol/sdk zod
npm install -D typescript @types/node tsx
npx tsc --init --target ES2022 --module nodenext --moduleResolution nodenext --outDir dist
Py:
mkdir -p $PROJECT_NAME && cd $PROJECT_NAME
python -m venv .venv
source .venv/bin/activate
pip install mcp pydantic
2.2. Standard structure:
$PROJECT_NAME/
├── src/
│ ├── index.ts|main.py # Server entry point
│ ├── tools/ # One file per tool category
│ │ ├── index.ts|__init__.py
│ │ └── [category].ts|.py
│ └── utils/ # Shared utilities
│ └── validation.ts|.py
├── test/
│ ├── harness.ts|.py # MCP test harness
│ └── tools/
│ └── [category].test.ts|.py
├── package.json|pyproject.toml
├── tsconfig.json # TypeScript only
├── Dockerfile # If Docker requested
└── README.md
2.3. Bin entry npm (TS) | entry point Py:
TS package.json:
{
"name": "$PACKAGE_NAME",
"version": "1.0.0",
"type": "module",
"bin": { "$PACKAGE_NAME": "./dist/index.js" },
"scripts": {
"build": "tsc",
"start": "node dist/index.js",
"dev": "tsx src/index.ts",
"test": "tsx test/harness.ts"
}
}
→ Buildable skeleton w/ all deps installed.
If err: install fails → check net + registry. TS → Node ≥18. Py → Py ≥3.10.
Step 3: Tool Handlers from Spec
3.1. Parse spec → per tool, gen handler:
TS template:
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
import { z } from "zod";
export function registerTools(server: McpServer): void {
server.tool(
"tool_name",
"Tool description from spec",
{
param1: z.string().describe("Parameter description"),
param2: z.number().optional().default(10).describe("Optional param"),
},
async ({ param1, param2 }) => {
try {
// TODO: Implement tool logic
const result = await performAction(param1, param2);
return {
content: [{ type: "text", text: JSON.stringify(result, null, 2) }],
};
} catch (error) {
return {
content: [{ type: "text", text: `Error: ${(error as Error).message}` }],
isError: true,
};
}
}
);
}
Py template:
from mcp.server import Server
from mcp.types import Tool, TextContent
from pydantic import BaseModel
class ToolNameParams(BaseModel):
param1: str
param2: int = 10
async def handle_tool_name(params: ToolNameParams) -> list[TextContent]:
try:
result = await perform_action(params.param1, params.param2)
return [TextContent(type="text", text=json.dumps(result, indent=2))]
except Exception as e:
return [TextContent(type="text", text=f"Error: {e}")]
3.2. One handler file per category from spec.
3.3. Validation beyond type checking:
- String len limits
- Numeric bounds
- Enum constraints
- Required field enforce
3.4. Structured err responses for anticipated failures.
→ Handler file per category w/ typed params + err handling.
If err: ambiguous types → default string + TODO for manual refine.
Step 4: Configure Transport
4.1. Server entry w/ chosen transport:
stdio (TS):
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
import { registerTools } from "./tools/index.js";
const server = new McpServer({
name: "$PACKAGE_NAME",
version: "1.0.0",
});
registerTools(server);
const transport = new StdioServerTransport();
await server.connect(transport);
SSE (TS):
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
import { SSEServerTransport } from "@modelcontextprotocol/sdk/server/sse.js";
import { registerTools } from "./tools/index.js";
const server = new McpServer({
name: "$PACKAGE_NAME",
version: "1.0.0",
});
registerTools(server);
const transport = new SSEServerTransport("/messages", response);
await server.connect(transport);
4.2. Auth req → middleware:
- Bearer token → validate
Authorizationheader - API key → validate
X-API-Keyheader
4.3. Shebang for stdio → direct exec:
#!/usr/bin/env node
→ Working entry starts MCP server on transport.
If err: SDK ver ≠ import paths → check @modelcontextprotocol/sdk ver + adjust. SDK restructured paths between vers.
Step 5: Test Harness
5.1. Validate every tool:
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
import { InMemoryTransport } from "@modelcontextprotocol/sdk/inMemory.js";
import { Client } from "@modelcontextprotocol/sdk/client/index.js";
async function runTests(): Promise<void> {
const server = createServer();
const [clientTransport, serverTransport] = InMemoryTransport.createLinkedPair();
await server.connect(serverTransport);
const client = new Client({ name: "test-client", version: "1.0.0" });
await client.connect(clientTransport);
// Test: tools/list returns all expected tools
const tools = await client.listTools();
console.assert(tools.tools.length === EXPECTED_TOOL_COUNT);
// Test: each tool with valid input
for (const tool of tools.tools) {
const result = await client.callTool({
name: tool.name,
arguments: getTestInput(tool.name),
});
console.assert(!result.isError, `${tool.name} failed`);
}
// Test: each tool with invalid input returns isError
for (const tool of tools.tools) {
const result = await client.callTool({
name: tool.name,
arguments: getInvalidInput(tool.name),
});
console.assert(result.isError, `${tool.name} should reject invalid input`);
}
console.log("All tests passed");
}
5.2. Test fixtures per tool: valid, invalid, edge cases.
5.3. Add test script → package.json | pyproject.toml.
→ Harness exercises every tool w/ valid+invalid.
If err: InMemoryTransport not in SDK ver → fall back to spawning server as subproc + stdio pipes.
Step 6: Docs + Config
6.1. Gen README.md w/:
- Project desc
- Install instructions
- Claude Code config cmd
- Claude Desktop JSON snippet
- Tool listing w/ descs + param schemas
- Dev + test instructions
6.2. Gen Claude Code register cmd:
# stdio transport
claude mcp add $PACKAGE_NAME stdio "node" "dist/index.js"
# SSE transport
claude mcp add $PACKAGE_NAME -e API_KEY=your_key -- mcp-remote http://localhost:3000/mcp
6.3. Gen Claude Desktop config:
{
"mcpServers": {
"$PACKAGE_NAME": {
"command": "node",
"args": ["path/to/dist/index.js"]
}
}
}
6.4. Docker requested → gen Dockerfile:
FROM node:20-slim AS build
WORKDIR /app
COPY package*.json ./
RUN npm ci
COPY . .
RUN npm run build
FROM node:20-slim
WORKDIR /app
COPY --from=build /app/dist ./dist
COPY --from=build /app/node_modules ./node_modules
COPY --from=build /app/package.json .
ENTRYPOINT ["node", "dist/index.js"]
→ Complete docs + config for immediate use.
If err: README has placeholders → search project for actual vals to substitute. Docker fail → verify base img matches Node|Py ver.
Check
- Builds w/o errs (
npm run build|equiv) - Server starts + responds
tools/listJSON-RPC - Every tool from spec registered + discoverable
- Harness passes valid inputs all tools
- Harness confirms err responses invalid inputs
- Claude Code connects via
claude mcp add - README has working install + config
- Gen code passes lint (if configured)
Traps
- SDK import path changes:
@modelcontextprotocol/sdkrestructured between vers. Check installed ver export paths. - Forget shebang: stdio invoked directly needs
#!/usr/bin/env nodefirst line. - Block event loop: TS handlers must
async. Sync ops block all other tool calls. - Missing
type: "module": SDK uses ESM. Without → Node treats as CJS, imports fail. - Zod schema drift: Spec evolves but Zod not updated → silent fails. Gen schemas from single source of truth.
- stdout pollution: stdio uses stdout for JSON-RPC. Any
console.login handlers corrupts. Useconsole.error|file logger.
→
analyze-codebase-for-mcp— gen spec this skill consumesbuild-custom-mcp-server— manual impl for complexconfigure-mcp-server— connect scaffold → Claude Code/Desktoptroubleshoot-mcp-connection— debug post-deploycontainerize-mcp-server— Docker for distribution
GitHub 仓库
相关推荐技能
evaluating-llms-harness
测试该Skill通过60+个学术基准测试(如MMLU、GSM8K等)评估大语言模型质量,适用于模型对比、学术研究及训练进度追踪。它支持HuggingFace、vLLM和API接口,被EleutherAI等行业领先机构广泛采用。开发者可通过简单命令行快速对模型进行多任务批量评估。
cloudflare-cron-triggers
测试这个Claude Skill提供了关于Cloudflare Cron Triggers的完整知识库,用于通过cron表达式定时执行Workers。它支持配置周期性任务、维护作业和自动化工作流,并能处理常见的cron触发错误。开发者可以用它来设置定时任务、测试cron处理器,并集成Workflows和Green Compute功能。
webapp-testing
测试该Skill为开发者提供了基于Playwright的本地Web应用测试工具集,支持自动化测试前端功能、调试UI行为、捕获屏幕截图和查看浏览器日志。它包含管理服务器生命周期的辅助脚本,可直接作为黑盒工具运行而无需阅读源码。适用于需要快速验证本地Web应用界面和交互功能的开发场景。
finishing-a-development-branch
测试这个Skill用于开发分支完成后的集成决策,当代码实现完成且测试通过时,它会引导开发者选择合适的工作流。它首先验证测试状态,然后提供合并、创建PR或清理等结构化选项。核心价值在于确保代码质量的同时,标准化分支收尾流程。
