My MCP Server Q5j

🚀 我的 MCP 服务器

这是一个借助 mcp-framework 构建的模型上下文协议 (MCP) 服务器，可用于实现特定的工具功能并与 Claude Desktop 集成。

🚀 快速开始

你可以按照下面的步骤进行依赖安装和项目构建：

# 安装依赖
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

按照以下步骤将项目发布到 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 框架文档