MCP Server Template

🚀 MCP 服務器模板 🛠️

本項目是一個用於構建您自己的模型上下文協議（MCP）服務器的起始模板。它提供了創建自定義 MCP 所需的基本結構和設置，這些 MCP 可用於與 Cursor 或 Claude Desktop 協同工作，助力開發者快速搭建相關服務器。

✨ 主要特性

• 採用 TypeScript 進行基本 MCP 服務器設置。
• 包含樣本工具實現，方便開發者參考。
• 擁有立即可用的項目結構，節省開發時間。
• 基於 @modelcontextprotocol/sdk 構建。

📦 安裝指南

克隆此模板

git clone [your-repo-url] my-mcp-server
cd my-mcp-server

安裝依賴

pnpm install

構建項目

pnpm run build

這將生成/build/index.js文件，即您編譯好的 MCP 服務器腳本。

🚀 快速開始

完成上述安裝步驟後，您就可以使用該 MCP 服務器模板了。以下是與不同工具結合使用的具體步驟。

與 Cursor 一起使用

1. 轉到 Cursor 設置 -> MCP -> 添加新的 MCP 服務器。
2. 配置您的 MCP：
   • 名稱：[自定義名稱]
   • 類型：命令
   • 命令：node 絕對路徑到MCP服務器/build/index.js

與 Claude Desktop 一起使用

在您的 Claude Desktop 配置中添加以下 MCP 配置：

{
  "mcpServers": {
    "your-mcp-name": {
      "command": "node",
      "args": ["絕對路徑到MCP服務器/build/index.js"]
    }
  }
}

💻 使用示例

基礎用法

該模板包括index.ts中的樣本工具實現。要創建自己的 MCP，可按以下步驟操作：

修改服務器配置

const server = new McpServer({
  name: "your-mcp-name",
  version: "0.0.1",
});

定義自定義工具

server.tool(
  "your-tool-name",
  "您的工具描述",
  {
    // 使用Zod模式定義您的工具參數
    parameter: z.string().describe("參數描述"),
  },
  async ({ parameter }) => {
    // 實現您的工具邏輯
    return {
      content: [
        {
          type: "text",
          text: "您的工具響應",
        },
      ],
    };
  }
);

構建並測試實現

npm run build

📚 詳細文檔

項目結構

mcp-server-template/
├── index.ts        # 主服務器實現文件
├── package.json    # 項目依賴
├── tsconfig.json   # TypeScript配置
└── build/         # 編譯後的JavaScript輸出

📄 許可證

本項目採用 MIT 許可證。

貢獻

隨時提交問題和改進請求！