Skip to main content
Glama
deenesjakoruzh
Freddymhs

template-mcp

by Freddymhs
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

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

Skript

Beschreibung

pnpm dev

Start mit Hot-Reload (tsx watch)

pnpm build

Kompiliert TypeScript + löst Aliase auf

pnpm start

Führt den kompilierten Server aus

pnpm test

Führt Tests aus

pnpm lint

Linting des Quellcodes

pnpm type-check

Typ-Prüfung ohne Emit

Konfiguration

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

Variable

Standard

Beschreibung

MCP_TRANSPORT

stdio

Transport: stdio oder http

PORT

3000

HTTP-Port (nur für http-Transport)

LOG_LEVEL

info

Pino-Log-Level

NODE_ENV

development

Umgebung

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}` }],
    }),
  );
}

  1. 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
}

  1. 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

Check

Befehl

Lint + Formatierung

pnpm lint

Strenge Typisierung

pnpm type-check

Build (tsc + Alias)

pnpm build

Unit-Tests (11/11)

pnpm test

Suite

Deckung

greet.tool.spec.ts (5)

Auflistung, Stile casual/formal/enthusiastic, Ablehnung bei leerem Namen

server-info.resource.spec.ts (2)

Auflistung, JSON-Felder (name, version, uptime, timestamp)

summarize.prompt.spec.ts (4)

Auflistung, Stile brief/bullet-points, numerische Koersion, Defaults

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

Verifizierter Endpunkt

Erwartetes Ergebnis

tools/call greet {"name":"Freddy","style":"casual"}

"Hey Freddy! How's it going?"

resources/read info://server

JSON mit name, version, uptime, nodeVersion, timestamp

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.

Available Tools

1 tool
greetGreet UserA
Read-onlyIdempotent

Generates a personalized greeting message. Use this tool when you need to greet someone by name with an optional custom greeting style.

ParametersJSON Schema
NameRequiredDescriptionDefault
nameYesThe name of the person to greet
styleNoThe greeting style to usecasual

TDQS

A4.2/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already indicate readOnlyHint=true, destructiveHint=false, and idempotentHint=true, so the description does not need to repeat those. It adds the behavioral detail that the greeting is 'personalized' and that style is optional with a default value, which is sufficient given the high annotation coverage.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, clear sentence that is front-loaded with the main action and immediately provides usage guidance. Every word is necessary and there is no redundant information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's simplicity (2 parameters, no output schema, no nested objects) and the rich annotations, the description is complete enough. It covers the purpose and usage adequately. No output schema is needed as the return is self-evident.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already documents both parameters thoroughly (name with length constraints, style with enum and default). The description adds no new parameter information beyond what's in the schema, earning a baseline score of 3.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states that the tool generates a personalized greeting message, with a specific verb ('greet') and resource ('someone by name'). It also mentions the optional custom greeting style, distinguishing it from any potential siblings (though none exist).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explicitly says 'Use this tool when you need to greet someone by name with an optional custom greeting style,' providing clear usage context. However, it does not specify when not to use it or mention any alternatives, but since there are no siblings, this is adequate.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

  1. 1 tool updatev1.0.0
    • First observedgreet
Deploy Server
Shareable, User-Owned Context BackendPeople, applications, and agents read, write, and coordinate together in one context lake. Reach it over MCP, a CLI, a Python SDK, or REST.fulcradynamics.comAd

TDQS

A3.8/5.0

Scored across 1 tool

Disambiguation5/5

Only one tool exists, so there is no ambiguity in choosing between tools.

Naming Consistency3/5

With only one tool, consistency is not applicable, but the name 'greet' is clear and follows a common verb pattern.

Tool Count2/5

A single tool for a server called 'template-mcp' suggests an extremely narrow scope, which is likely insufficient for meaningful tasks.

Completeness2/5

The server only offers a greeting function, which is too limited for any substantial workflow; missing any broader functionality.

Maintenance

ActivityInactive
ResponsivenessNo issues

Resources

Related MCP Connectors

Related MCP Servers

  • MCP Base Server

    yone-k
    A
    license
    Not graded
    quality
    D
    maintenance
    A TypeScript-based template for rapidly developing MCP servers with modular tool architecture, built-in validation using Zod schemas, and comprehensive error handling.
    9 npm
    MIT

  • xmcp Application

    SumitNawathe
    F
    license
    Not graded
    quality
    D
    maintenance
    A Model Context Protocol (MCP) server template designed for building structured tools, prompts, and resources with built-in support for HTTP and STDIO transports. It provides a standardized framework for developers to create and deploy AI-driven services using TypeScript and Zod schema validation.
    8 npm
    -

  • MCP Starter Kit

    iamdipanshusingh
    A
    license
    Not graded
    quality
    D
    maintenance
    A minimal TypeScript MCP server template with example tool, Zod validation, stdio transport, and dotenv setup.
    8 npm
    MIT