MCP Server Boilerplate (typescript)

🚀 MCP サーバー説明

MCP（Machine Communicator Protocol）は、機械間通信に使用されるプロトコルです。このプロジェクトは、開発とテストに適したシンプルな HTTP サーバーの実装を提供します。

🚀 クイックスタート

1. mcp.json ファイルを作成します。

{
  "name": "示例 MCP 服务器",
  "version": "0.1.0",
  "description": "这是一个简单的 MCP 服务器。",
  "tools": [
    {
      "id": "tool1",
      "name": "工具1",
      "description": "执行任务的工具。"
    }
  ]
}

2. server.ts ファイルを作成します。

import { MCP } from 'mcp-server';

async function bootstrap() {
  const server = new MCP.Server({
    port: 3000,
    jsonPath: './mcp.json'
  });

  await server.start();
}

bootstrap().catch(console.error);

3. サーバーを起動します。

npm run start

✨ 主な機能

• ツール登録：mcp.json を通じてツールを定義できます。
• 通信プロトコル：MCP プロトコル標準に準拠しています。
• プラグイン拡張：プラグインシステムを提供し、機能拡張が容易です。

📦 インストール

npm を使用してプロジェクトをインストールします。

npm install mcp-server

💻 使用例

基本的な使用法

ツールの作成

mcp.json でツールを定義します。

{
  "tools": [
    {
      "id": "tool1",
      "name": "计算器工具",
      "description": "执行数学运算。",
      "parameters": [
        { "type": "number", "name": "a" },
        { "type": "number", "name": "b" }
      ],
      "responseType": "number"
    }
  ]
}

ツールの呼び出し

HTTP リクエストを通じてツールを呼び出します。

curl -X POST http://localhost:3000/api/tool/tool1 \
     -H "Content-Type: application/json" \
     -d '{"a": 10, "b": 20}'

応答例：

{
  "status": "success",
  "result": 30
}

📚 ドキュメント

ディレクトリ

• 概要
• インストール
• クイックスタート
• 主な機能
• 使用例
• 拡張と設定

詳細説明

インストールガイド

1. リポジトリをクローンします。

git clone https://github.com/username/mcp-server.git

2. 依存関係をインストールします。

npm install

クイックスタート手順

1. mcp.json ファイルを作成します。
2. サーバーコードを記述します。
3. サービスを起動します。

機能モジュール

• ツール管理：ツールの登録と呼び出しを処理します。
• 通信プロトコル：データ交換の標準フローを実装します。
• プラグインサポート：プラグインによる機能拡張を許可します。

🔧 技術詳細

サンプルプロジェクト構造

mcp-server-example/
├── package.json
├── mcp.json
└── src/
    └── server.ts

サンプルの実行

npm install
npm run start

エラー処理

• パラメータエラー：400 ステータスコードを返します。
• サービス内部エラー：500 ステータスコードを返します。

🤝 コントリビューションガイド

コードの貢献を歓迎します！以下の手順に従ってください。

1. ブランチを作成します。
2. 変更をコミットします。
3. プルリクエストを送信します。

📄 ライセンス

このプロジェクトは MIT ライセンスのもとで公開されています。詳細な条項は LICENSE ファイルを参照してください。