My MCP Server Q5j

🚀 我的 MCP 服務器

這是一個藉助 mcp-framework 構建的模型上下文協議 (MCP) 服務器，能為相關應用提供強大的功能支持，助力項目高效運行。

🚀 快速開始

# 安裝依賴
npm install

# 構建項目
npm run build

📦 項目結構

my-mcp-server/
├── src/
│   ├── tools/        # MCP 工具
│   │   └── ExampleTool.ts
│   └── index.ts      # 服務器入口文件
├── package.json
└── tsconfig.json

✨ 添加組件

項目在 src/tools/ExampleTool.ts 處附帶了一個示例工具。你可通過 CLI 添加更多工具：

# 添加一個新的工具
mcp add tool my-tool

# 你可能創建的示例工具：
mcp add tool data-processor
mcp add tool api-client
mcp add tool file-handler

💻 使用示例

基礎用法

import { MCPTool } from "mcp-framework";
import { z } from "zod";

interface MyToolInput {
  message: string;
}

class MyTool extends MCPTool<MyToolInput> {
  name = "my_tool";
  description = "描述你的工具的功能";

  schema = {
    message: {
      type: z.string(),
      description: "此輸入參數的描述",
    },
  };

  async execute(input: MyToolInput) {
    // 在此處編寫你的工具邏輯
    return `處理後：${input.message}`;
  }
}

export default MyTool;

📦 發佈到 npm

步驟 1：更新 package.json

• 確保 name 唯一且符合 npm 命名規範
• 設置合適的 version
• 添加 description、author、license 等信息
• 檢查 bin 是否指向正確的入口文件

步驟 2：本地構建和測試

npm run build
npm link
my-mcp-server  # 在本地測試你的 CLI

步驟 3：登錄到 npm（如果需要創建賬戶）

npm login

步驟 4：發佈你的包

npm publish

發佈後，用戶可以在他們的 Claude 桌面客戶端中添加它（閱讀下方說明）或使用 npx 運行。

📚 與 Claude Desktop 集成

本地開發

在你的 Claude Desktop 配置文件中添加以下內容：

MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json Windows: %APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "my-mcp-server": {
      "command": "node",
      "args":["/絕對路徑/to/my-mcp-server/dist/index.js"]
    }
  }
}

發佈後

在你的 Claude Desktop 配置文件中添加以下內容：

MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json Windows: %APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "my-mcp-server": {
      "command": "npx",
      "args": ["my-mcp-server"]
    }
  }
}

🔧 構建和測試

1. 修改你的工具
2. 運行 npm run build 進行編譯
3. 服務器在啟動時會自動加載你的工具

📚 學習更多

• MCP 框架 Github
• MCP 框架文檔