Pocha MCP Server

🚀 Pocha MCP 服務器

Pocha MCP 服務器是一個專為 Pocha 項目打造的工具，它基於模型上下文協議 (MCP)，能夠依據一致的模式，自動生成類型安全的 TypeScript API 函數模板，極大提升 API 開發的效率與準確性。

✨ 主要特性

• 🔍 精準生成：生成帶有正確類型的 TypeScript API 函數，確保類型安全。
• 📡 全方法支持：支持 GET、POST、PUT、DELETE 等常見 HTTP 方法。
• 🔑 安全認證：具備身份驗證令牌處理機制，保障 API 請求的安全性。
• ❌ 錯誤處理：生成正確的錯誤處理和響應類型，增強代碼的健壯性。
• ⚙️ 靈活可選：支持可選參數和返回類型，滿足多樣化的開發需求。

📦 安裝指南

# 克隆倉庫
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：基於模型上下文協議的 SDK，為 API 函數生成提供核心支持。
• 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 文件以瞭解許可信息。

貢獻者

• [你的名字] - 項目作者

參謝

感謝所有貢獻者和提供反饋的人。