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 框架文档