qdxs-add-mcp-server

一个使用mcp-framework构建的模型上下文协议（MCP）服务器。

快速入门

# 安装依赖
npm install

# 构建项目
npm run build

项目结构

qdxs-add-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
   qdxs-add-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": {
    "qdxs-add-mcp-server": {
      "command": "node",
      "args":["/absolute/path/to/qdxs-add-mcp-server/dist/index.js"]
    }
  }
}

发布后

将以下配置添加到你的 Claude Desktop 配置文件：

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

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

构建和测试

1. 修改你的工具代码
2. 运行 npm run build 编译
3. 服务器启动后会自动加载你的工具

更多信息

• MCP Framework Github
• MCP Framework 文档