mirror of
https://github.com/affaan-m/everything-claude-code.git
synced 2026-03-30 13:43:26 +08:00
cd82517b90
* feat(skills): add mcp-server-patterns Made-with: Cursor * chore: add mcp-server-patterns to .agents/skills and .cursor/skills (cross-harness) Made-with: Cursor * fix: address PR review — When to Use / How It Works / Examples sections; Prompts primitive; stdio connect example; Streamable HTTP; resource handler(uri); SDK API note (tool vs registerTool) Made-with: Cursor * mcp-server-patterns: replace invalid StdioServerTransport.create() with version-agnostic note Made-with: Cursor * mcp-server-patterns: remove GitHub link, document SDK signature variance Made-with: Cursor
68 lines
3.8 KiB
Markdown
68 lines
3.8 KiB
Markdown
---
|
||
name: mcp-server-patterns
|
||
description: Build MCP servers with Node/TypeScript SDK — tools, resources, prompts, Zod validation, stdio vs Streamable HTTP. Use Context7 or official MCP docs for latest API.
|
||
origin: ECC
|
||
---
|
||
|
||
# MCP Server Patterns
|
||
|
||
The Model Context Protocol (MCP) lets AI assistants call tools, read resources, and use prompts from your server. Use this skill when building or maintaining MCP servers. The SDK API evolves; check Context7 (query-docs for "MCP") or the official MCP documentation for current method names and signatures.
|
||
|
||
## When to Use
|
||
|
||
Use when: implementing a new MCP server, adding tools or resources, choosing stdio vs HTTP, upgrading the SDK, or debugging MCP registration and transport issues.
|
||
|
||
## How It Works
|
||
|
||
### Core concepts
|
||
|
||
- **Tools**: Actions the model can invoke (e.g. search, run a command). Register with `registerTool()` or `tool()` depending on SDK version.
|
||
- **Resources**: Read-only data the model can fetch (e.g. file contents, API responses). Register with `registerResource()` or `resource()`. Handlers typically receive a `uri` argument.
|
||
- **Prompts**: Reusable, parameterised prompt templates the client can surface (e.g. in Claude Desktop). Register with `registerPrompt()` or equivalent.
|
||
- **Transport**: stdio for local clients (e.g. Claude Desktop); Streamable HTTP is preferred for remote (Cursor, cloud). Legacy HTTP/SSE is for backward compatibility.
|
||
|
||
The Node/TypeScript SDK may expose `tool()` / `resource()` or `registerTool()` / `registerResource()`; the official SDK has changed over time. Always verify against the current [MCP docs](https://modelcontextprotocol.io) or Context7.
|
||
|
||
### Connecting with stdio
|
||
|
||
For local clients, create a stdio transport and pass it to your server’s connect method. The exact API varies by SDK version (e.g. constructor vs factory). See the official MCP documentation or query Context7 for "MCP stdio server" for the current pattern.
|
||
|
||
Keep server logic (tools + resources) independent of transport so you can plug in stdio or HTTP in the entrypoint.
|
||
|
||
### Remote (Streamable HTTP)
|
||
|
||
For Cursor, cloud, or other remote clients, use **Streamable HTTP** (single MCP HTTP endpoint per current spec). Support legacy HTTP/SSE only when backward compatibility is required.
|
||
|
||
## Examples
|
||
|
||
### Install and server setup
|
||
|
||
```bash
|
||
npm install @modelcontextprotocol/sdk zod
|
||
```
|
||
|
||
```typescript
|
||
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
|
||
import { z } from "zod";
|
||
|
||
const server = new McpServer({ name: "my-server", version: "1.0.0" });
|
||
```
|
||
|
||
Register tools and resources using the API your SDK version provides: some versions use `server.tool(name, description, schema, handler)` (positional args), others use `server.tool({ name, description, inputSchema }, handler)` or `registerTool()`. Same for resources — include a `uri` in the handler when the API provides it. Check the official MCP docs or Context7 for the current `@modelcontextprotocol/sdk` signatures to avoid copy-paste errors.
|
||
|
||
Use **Zod** (or the SDK’s preferred schema format) for input validation.
|
||
|
||
## Best Practices
|
||
|
||
- **Schema first**: Define input schemas for every tool; document parameters and return shape.
|
||
- **Errors**: Return structured errors or messages the model can interpret; avoid raw stack traces.
|
||
- **Idempotency**: Prefer idempotent tools where possible so retries are safe.
|
||
- **Rate and cost**: For tools that call external APIs, consider rate limits and cost; document in the tool description.
|
||
- **Versioning**: Pin SDK version in package.json; check release notes when upgrading.
|
||
|
||
## Official SDKs and Docs
|
||
|
||
- **JavaScript/TypeScript**: `@modelcontextprotocol/sdk` (npm). Use Context7 with library name "MCP" for current registration and transport patterns.
|
||
- **Go**: Official Go SDK on GitHub (`modelcontextprotocol/go-sdk`).
|
||
- **C#**: Official C# SDK for .NET.
|