🚀 我的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":["/absolute/path/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. 服务器启动后会自动加载你的工具。