MCP Typescript Server Starter

🚀 MCP TypeScript プロジェクトガイド

MCP（「Multi - Chat Protocol」などの特定の略語を指す可能性があります）は、TypeScriptに基づくサーバーフレームワークで、複雑なチャットや通信システムの構築と管理に使用されます。このガイドでは、このフレームワークを使用して機能が充実したサーバーを実装する方法を詳しく説明します。

🚀 クイックスタート

プロジェクトの初期化

1. 新しいプロジェクトを作成する

   mkdir my-mcp-server && cd my-mcp-server
   

2. 依存関係をインストールする

   npm init -y
   npm install mcp-server typescript --save-dev
   

3. TypeScriptを設定する tsconfig.json に以下の内容を追加します。

   {
     "compilerOptions": {
       "target": "ES2020",
       "module": "CommonJS",
       "outDir": "./dist",
       "rootDir": "./src",
       "strict": true,
       "esModuleInterop": true,
       "skipLibCheck": true
     }
   }
   

4. メインファイルを作成する src/index.ts に以下の内容を追加します。

   import { MCPServer } from 'mcp-server';
   
   const server = new MCPServer({
     port: 3001,
     hostname: 'localhost',
   });
   
   // ツール、リソース、プロンプトを登録する（後述）
   server.start();
   

5. プロジェクトを実行する

   npm run dev
   

✨ 主な機能

ツールの定義

src/index.ts では、以下の方法で簡単なエコーツールを登録できます。

server.tool("echo", { message: z.string() }, async ({ message }) => ({
  content: [{ type: "text", text: `Tool echo: ${message}` }],
}));

リソースの定義

以下のコードを使用して、URIベースのリソースアクセスを実装できます。

server.resource(
  "echo",
  new ResourceTemplate("echo://{message}", { list: undefined }),
  async (uri, { message }) => ({
    contents: [
      {
        uri: uri.href,
        text: `Resource echo: ${message}`,
      },
    ],
  })
);

プロンプトの定義

src/index.ts では、プロンプトテンプレートを登録できます。

server.prompt("echo", { message: z.string() }, ({ message }) => ({
  messages: [
    {
      role: "user",
      content: {
        type: "text",
        text: `Please process this message: ${message}`,
      },
    },
  ],
}));

📚 ドキュメント

サーバーの設定

エンドポイントとインターフェイス

• デフォルトのポート：3001
• デフォルトのホスト名：localhost
• リッスンアドレス：0.0.0.0（外部からのアクセスを許可）

ログとデバッグ

以下の方法でログ記録を有効にします。

server.configure({
  logging: {
    enabled: true,
    level: 'debug',
  },
});

デプロイと拡張

Dockerを使用したデプロイ

1. Dockerfileを作成する

   FROM node:16
   
   WORKDIR /app
   
   COPY package.json ./
   RUN npm install
   
   COPY src/ ./src/
   
   EXPOSE 3001
   
   CMD ["npm", "run", "start"]
   

2. イメージをビルドする

   docker build -t mcp-server .
   

3. コンテナを実行する

   docker run -p 3001:3001 --name mcp-server mcp-server
   

環境変数

環境変数の設定

src/index.ts では、以下の方法で環境変数を読み取ることができます。

const port = process.env.PORT || 3001;

サンプル設定ファイル

.env ファイルを作成します。

PORT=3001
NODE_ENV=development

デバッグ情報

デバッグログの出力

src/index.ts に以下のコードを追加して、デバッグ情報を出力できます。

server.on('debug', (message) => {
  console.log(`Debug: ${message}`);
});

エラーのキャッチ

以下の方法でエラーをキャッチして処理します。

server.on('error', (error) => {
  console.error(`Error: ${error.message}`);
});

ベストプラクティス

コード構造

• モジュール化：機能を複数のファイルに分割します。例えば、tools/、resources/、prompts/ などです。
• 依存関係の管理：package.json を使用してすべての依存関係を管理します。
• バージョン管理：git を使用してバージョン管理を行います。

パフォーマンスの最適化

1. キャッシュ：

   const cache = new Map();
   

2. 非同期操作：

   async function handleRequest() {
     await someAsyncFunction();
   }
   

📄 ライセンス

このプロジェクトはMITライセンスに従います。具体的な内容は以下の通りです。

著作権 (c) 2023 あなたの名前/会社名。
このソフトウェアはソースコード形式で配布され、誰でも自由に使用、複製、修正、配布することができますが、以下の条件を遵守する必要があります。

• 配布する派生作品には著作権表示とライセンス表示を含める必要があります。

付録

よくある質問

1. ポートを変更するにはどうすればいいですか？

   server.configure({
     port: 3002,
   });
   

2. ログを無効にするにはどうすればいいですか？

   server.configure({
     logging: {
       enabled: false,
     },
   });
   

コントリビュートガイド

コントリビューションを歓迎します！このリポジトリをフォークし、gh - pages ブランチに変更を提出してください。

以上の手順に従えば、MCP TypeScriptプロジェクトを簡単に始めることができ、必要に応じて機能を拡張し最適化することができます。