Pocha MCP Server

🚀 Pocha MCP サーバー

Pocha プロジェクト用の TypeScript API 関数を生成するモデルコンテキストプロトコル (MCP) サーバーです。このサーバーは、一貫したパターンに基づいて型安全な API 関数テンプレートを自動生成するツールを提供します。

🚀 クイックスタート

Pocha MCP サーバーは、Pocha プロジェクト用の TypeScript API 関数を生成するための便利なツールです。以下の手順に従って、サーバーをセットアップして使用してください。

✨ 主な機能

• 正しい型付けされた TypeScript API 関数を生成します。
• GET、POST、PUT、DELETE の HTTP メソッドをサポートします。
• 認証トークンの処理をサポートします。
• 正しいエラー処理とレスポンス型を生成します。
• オプションのパラメータと戻り値の型をサポートします。

📦 インストール

# リポジトリをクローンする
git clone https://github.com/jiohjung98/pocha-mcp-server.git

# 依存関係をインストールする
pnpm install

# プロジェクトをビルドする
pnpm build

💻 使用例

基本的な使用法

サーバーは generate-api-function というツールを提供しており、以下のパラメータを受け取ります。

{
  functionName: string;          // 生成する API 関数の名前
  route: string;                 // API ルートのパス（例："/pocha/${pochaid}"）
  method: "GET" | "POST" | "PUT" | "DELETE";  // HTTP メソッド
  params?: {                     // オプションのパラメータ配列
    name: string;               // パラメータ名
    type: string;               // パラメータの型
  }[];
  returnType: string;           // 関数の戻り値の型
}

高度な使用法

Pocha 情報を取得する API 関数を生成する例です。

// 入力パラメータ
{
  "functionName": "getPocha",
  "route": "/pocha/${pochaid}",
  "method": "GET",
  "params": [
    {
      "name": "pochaid",
      "type": "number"
    }
  ],
  "returnType": "PochaInfo"
}

// 生成される出力
/**
 * @desc Pocha 情報を取得する
 * @route GET /pocha/${pochaid}
 */
export async function getPocha(pochaid: number, token: string): Promise<PochaInfo> {
  const url = `/pocha/${pochaid}`;
  try {
    const response = await client.get(url, {
      headers: {
        Authorization: `Bearer ${token}`,
      },
    });

    return response?.data;
  } catch (error) {
    console.log(error);
    throw new Error("Error in getPocha");
  }
}

🔧 技術詳細

サーバーは以下の技術を使用して構築されています。

• TypeScript
• MCP TypeScript SDK
• Zod を使用したスキーマ検証

開発を開始するには、以下のコマンドを実行します。

# 依存関係をインストールする
pnpm install

# 監視モードでビルドする
pnpm dev

📚 ドキュメント

プロジェクト構造

pocha-mcp-server/
├── src/
│   └── index.ts     # メインサーバーの実装ファイル
├── dist/            # コンパイルされた JavaScript のフォルダ
├── package.json
└── tsconfig.json

Cursor の設定

Cursor IDE でこの MCP サーバーを使用するには、以下の手順に従ってください。

1. Cursor MCP 設定ファイルを開きます。

   # macOS
   ~/.cursor/mcp.json
   
   # Windows
   %APPDATA%/cursor/mcp.json
   
   # Linux
   ~/.cursor/mcp.json
   

2. mcpServers オブジェクトに以下の設定を追加します。

   {
     "mcpServers": {
       "pocha-api-generator": {
         "command": "/opt/homebrew/bin/npx",
         "args": ["-y", "node", "/path/to/your/pocha-mcp-server/dist/index.js"]
       }
     }
   }
   

   /path/to/your/pocha-mcp-server を実際にクローンしたリポジトリのパスに置き換えてください。
3. Cursor を再起動して変更を有効にします。
4. これで、MCP サーバーが Cursor で使用可能になり、自然言語コマンドを入力することで API 関数を生成できます。例えば、以下のようなコマンドを入力できます。

   Can you create a sample API for pocha project that fetches PochaInfo from "/pocha/${pochaid}" using "pocha-api-generator" mcp?
   

📄 ライセンス

ライセンス情報については、プロジェクトの LICENSE ファイルを参照してください。

貢献者

• [あなたの名前] - プロジェクトの作者

謝辞

すべての貢献者とフィードバックを提供してくれた方々に感謝します。