template-mcp

MCP (Model Context Protocol) Server-Template mit TypeScript, Zod-Validierung und Unterstützung für dualen Transport (stdio/HTTP). Kompatibel mit jedem MCP-Client: Claude Code, Claude Desktop, Cursor, VS Code Copilot, Windsurf, Cline und mehr.

Funktionen

• Dualer Transport: stdio (lokal) und Streamable HTTP (remote)

• TypeScript strict mit ESM-Modulen

• Zod-Validierung für Tool-Eingabeschemata

• Joi-Umgebungsvalidierung (Fail-Fast beim Start)

• Pino-Logging nach stderr (stdio-sicher)

• Modulare Architektur: Tools, Ressourcen und Prompts als separate Module

• Factory-Pattern: createServer() für Testbarkeit

• Vollständige Test-Suite mit MCP SDK In-Memory-Transport

• Qualitäts-Tooling: ESLint + Prettier + Husky + lint-staged

• Docker-bereit: Multi-Stage-Build

• CI/CD: GitHub Actions Pipeline

Related MCP server: xmcp Application

Schnellstart

pnpm install
pnpm dev

Skripte

Konfiguration

Kopiere .env.example nach .env und passe sie an:

Projektstruktur

src/
├── main.ts              # Entrypoint: transport selection
├── server.ts            # createServer() factory
├── config/              # Env validation + constants
├── common/              # Logger, error helpers, types
├── tools/               # MCP tools (callable by LLMs)
├── resources/           # MCP resources (read-only data)
└── prompts/             # MCP prompts (reusable templates)

Hinzufügen eines neuen Tools

1. Erstelle src/tools/my-tool.tool.ts:

import type { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
import { z } from 'zod';

export function registerMyTool(server: McpServer): void {
  server.registerTool(
    'my_tool',
    {
      title: 'My Tool',
      description: 'What this tool does',
      inputSchema: {
        param: z.string().describe('Parameter description'),
      },
      annotations: {
        readOnlyHint: true,
        destructiveHint: false,
        idempotentHint: true,
        openWorldHint: false,
      },
    },
    async ({ param }) => ({
      content: [{ type: 'text', text: `Result: ${param}` }],
    }),
  );
}

2. Registriere es in src/tools/index.ts:

import { registerMyTool } from './my-tool.tool.js';

export function registerTools(server: McpServer): void {
  registerGreetTool(server);
  registerMyTool(server); // add here
}

3. Füge Tests in src/tools/__tests__/my-tool.tool.spec.ts hinzu

Client-Konfiguration

Claude Code

Hinzufügen zu .claude/settings.json:

{
  "mcpServers": {
    "template-mcp": {
      "command": "node",
      "args": ["/absolute/path/to/template-mcp/dist/main.js"]
    }
  }
}

Claude Desktop

Hinzufügen zu claude_desktop_config.json:

{
  "mcpServers": {
    "template-mcp": {
      "command": "node",
      "args": ["/absolute/path/to/template-mcp/dist/main.js"]
    }
  }
}

Cursor

Hinzufügen zu Cursor Settings > MCP Servers:

{
  "mcpServers": {
    "template-mcp": {
      "command": "node",
      "args": ["/absolute/path/to/template-mcp/dist/main.js"]
    }
  }
}

VS Code (Copilot)

Hinzufügen zu .vscode/settings.json:

{
  "mcp": {
    "servers": {
      "template-mcp": {
        "command": "node",
        "args": ["/absolute/path/to/template-mcp/dist/main.js"]
      }
    }
  }
}

Docker

# Build
docker build -t template-mcp .

# Run (HTTP mode, used for remote access)
docker run -p 3000:3000 template-mcp

Tech-Stack

• Node.js 22 + TypeScript (strict, ESM)

• MCP SDK v1 (@modelcontextprotocol/sdk)

• Zod (Tool-Eingabevalidierung)

• Joi (Umgebungsvalidierung)

• Pino (stderr-Logging)

• Vitest (Testing)

• ESLint + Prettier + Husky

Verifizierung

Alles Folgende ist geprüft und funktioniert zu 100%.

Code-Qualität

Unit-Tests (11/11)

pnpm test

Kein Netzwerk oder Ports — verwendet InMemoryTransport des SDKs.

Runtime — stdio-Transport (Standardmodus)

echo '{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2024-11-05","capabilities":{},"clientInfo":{"name":"test","version":"1.0.0"}}}' \
  | MCP_TRANSPORT=stdio node dist/main.js

JSON-RPC-Antwort auf stdout, Logs auf stderr.

Runtime — HTTP-Transport

MCP_TRANSPORT=http PORT=3100 node dist/main.js &
# Initialize → capturar Mcp-Session-Id del header
# tools/list, resources/list, prompts/list, tools/call greet, resources/read info://server

Docker

docker build -t template-mcp .  # multi-stage: base → deps → build → production
docker run -p 3000:3000 template-mcp  # arranca en HTTP mode

CI (GitHub Actions)

pnpm install → pnpm lint → pnpm build → pnpm test Läuft bei jedem Push und PR auf main/master.

Commit-Pipeline (lokal)

git commit → husky → lint-staged → eslint --fix + prettier --write (nur gestagte Dateien)

Bekannte Lücken

• HTTP-Transport ohne automatisierte Tests (mittel): Die Unit-Tests verwenden InMemoryTransport; der HTTP-Transport (StreamableHTTPServerTransport) wurde nur manuell mit curl verifiziert. Für Remote-Produktion sollten Integrationstests mit einer echten Sitzung hinzugefügt werden.

• Integration mit MCP-Client (mittel): Manuelle Verifizierung durch Hinzufügen zu .claude/settings.json oder Cursor und Bestätigung, dass Tools/Ressourcen/Prompts im Client erscheinen.

• Extreme Tool-Eingaben (niedrig): Sehr lange Strings, fehlerhaftes Unicode — Zod lehnt diese ab, aber die Fehlerantwort ist nicht via HTTP getestet.

• Gleichzeitige Sitzungen (niedrig): Außerhalb des Scopes eines Templates.