Skip to main content
Glama
stevennevins

MCP Server Template

by stevennevins

MCP サーバー テンプレート

TypeScriptでモデルコンテキストプロトコル(MCP)サーバーを作成するためのテンプレートです。このテンプレートは、適切なツール、型安全性、そしてベストプラクティスを用いて、MCP互換サーバーを構築するための強固な基盤を提供します。

特徴

  • 🚀 TypeScriptの完全サポート

  • 🏗️ コンテナベースの依存性注入

  • 📦 DataProcessor インターフェースを使用したサービスベースのアーキテクチャ

  • 🛠️ テストを含むツール実装の例

  • 🧪 Vitest テストフレームワーク

  • 📝 型定義

  • 🔌 MCP SDK 統合

Related MCP server: MCP Server Template

はじめる

発達

  1. 依存関係をインストールします:

    npm install
  2. ホット リロードで開発サーバーを起動します。

    npm run dev
  3. プロジェクトをビルドします。

    npm run build
  4. テストを実行します:

    npm test
  5. 本番サーバーを起動します。

    npm start

プロジェクト構造

src/
├── index.ts          # Entry point
├── interfaces/       # Interface definitions
│   └── tool.ts      # DataProcessor interface
└── tools/           # Tool implementations
    └── example.ts   # Example tool

ツールの作成

  1. src/tools/example.tsの例に従って、ツールとハンドラーをエクスポートします。

    // In your-tool.ts
    export const YOUR_TOOLS = [
      {
        name: "your-tool-name",
        description: "Your tool description",
        parameters: {
          // Your tool parameters schema
        },
      },
    ];
    
    export const YOUR_HANDLERS = {
      "your-tool-name": async (request) => {
        // Your tool handler implementation
        return {
          toolResult: {
            content: [{ type: "text", text: "Result" }],
          },
        };
      },
    };
  2. src/index.tsのALL_TOOLSおよびALL_HANDLERS定数にツールを登録します。

    // In src/index.ts
    import { YOUR_TOOLS, YOUR_HANDLERS } from "./tools/your-tool.js";
    
    // Combine all tools
    const ALL_TOOLS = [...EXAMPLE_TOOLS, ...YOUR_TOOLS];
    const ALL_HANDLERS = { ...EXAMPLE_HANDLERS, ...YOUR_HANDLERS };

サーバーは自動的に次の処理を実行します。

  • 利用可能なツールにツールをリストします

  • 入力検証を処理する

  • ツールへのリクエストを処理する

  • MCPプロトコルに従って応答をフォーマットする

テスト

テンプレートには、ローカル テスト用の組み込み TestClient と視覚的なデバッグ用の MCP Inspector が含まれています。

TestClientの使用

TestClient はツールをテストする簡単な方法を提供します。

import { TestClient } from "./utils/TestClient";

describe("YourTool", () => {
  const client = new TestClient();

  it("should process data correctly", async () => {
    await client.assertToolCall(
      "your-tool-name",
      { input: "test" },
      (result) => {
        expect(result.toolResult.content).toBeDefined();
      }
    );
  });
});

MCPインスペクターの使用

テンプレートには、ツールを視覚的にデバッグするための MCP インスペクターが含まれています。

  1. インスペクターを起動します。

    npx @modelcontextprotocol/inspector node dist/index.js
  2. http://localhost:5173でインスペクターUIを開きます。

検査官は以下を提供します:

  • テストツールのビジュアルインターフェース

  • リアルタイムのリクエスト/レスポンス監視

  • ツールメタデータ検査

  • インタラクティブなテスト環境

カーソルを使ったローカルテスト

Cursor を使用して MCP サーバーをローカルでテストするには:

  1. パッケージをビルドしてリンクします。

    npm run build
    npm run link
  2. バイナリが動作することを確認します。

    npx example-mcp-tool
  3. カーソルにサーバーを追加します。

    • カーソル設定を開く

    • 機能タブに移動します

    • MCPサーバーのセクションまでスクロールします

    • 「サーバーを追加」をクリックします

    • 「コマンド」タイプを選択

    • 名前を付けます(例:「ローカルサンプルツール」)

    • 次のコマンドを入力します: npx example-mcp-tool

    • 確認をクリック

  4. MCP サーバー セクションでサーバーが実行中であることが表示されていることを確認し、カーソルでサーバーが正しく起動していることを確認します。

注意: コードを変更した場合は、必ず再構築して再リンクしてください。

npm run build
npm run link

テストが完了したら、パッケージのリンクを解除できます。

npm run unlink

これにより、開発中に作成されたグローバル シンボリック リンクが削除されます。

Available Tools

1 tool
example-toolC

An example tool that processes input data

ParametersJSON Schema
NameRequiredDescriptionDefault
inputYesInput string to process

TDQS

C2.6/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It states the tool 'processes input data', which implies some action but doesn't reveal behavioral traits like whether it's read-only, destructive, requires authentication, has side effects, or rate limits. This leaves significant gaps in understanding how the tool behaves.

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

Conciseness4/5

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

The description is a single, efficient sentence with no wasted words, making it appropriately concise. However, it's front-loaded with the basic purpose but lacks structure or additional details that could enhance clarity, keeping it simple but under-specified.

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

Completeness2/5

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

Given the tool's simplicity (1 parameter, no output schema, no annotations), the description is incomplete. It doesn't explain what 'processes' means, the expected output, or behavioral context, leaving the agent with insufficient information to use the tool effectively despite the straightforward schema.

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?

The description adds no specific meaning about the 'input' parameter beyond what the schema provides, which has 100% coverage and describes it as 'Input string to process'. With high schema coverage, the baseline is 3, as the schema adequately documents the parameter, and the description doesn't compensate or add further semantics.

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

Purpose3/5

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

The description states the tool 'processes input data', which provides a basic purpose but is vague about what 'processes' entails. It doesn't specify the type of processing or outcome, and with no sibling tools, differentiation isn't needed. This is a minimal viable description that communicates a general function without specifics.

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

Usage Guidelines2/5

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

The description offers no guidance on when to use this tool, such as context, prerequisites, or alternatives. With no sibling tools, it doesn't need to distinguish from others, but it lacks any usage instructions or scenarios, leaving the agent without direction on appropriate application.

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 update
    • First observedexample-tool

TDQS

C2.8/5.0

Scored across 1 tool

Disambiguation5/5

With only one tool, there is no possibility of confusion or overlap between tools, as there are no other tools to compare it against. The single tool's purpose is clearly defined, eliminating any ambiguity in tool selection.

Naming Consistency5/5

Since there is only one tool, naming consistency is inherently perfect—there are no other tools to create inconsistency. The tool name 'example-tool' follows a simple, clear pattern without any conflicting conventions to evaluate.

Tool Count2/5

A single tool is generally too few for a server's purpose, as it limits functionality and suggests an incomplete or trivial implementation. For a server named 'MCP Server Template', one tool feels insufficient to demonstrate a coherent set of capabilities, making it borderline inadequate.

Completeness1/5

The server's purpose is unclear from the name 'MCP Server Template', but with only one generic tool ('example-tool'), there are significant gaps in coverage. It lacks any CRUD operations, lifecycle management, or domain-specific functions, making it severely incomplete for any practical application.

Maintenance

ActivityInactive
ResponsivenessNo issues

Related MCP Connectors

Related MCP Servers