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 文件以了解许可信息。

贡献者

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

参谢

感谢所有贡献者和提供反馈的人。