My MCP Server K6d

🚀 我的MCP服务器

这是一个借助mcp - framework构建的模型上下文协议（MCP）服务器，能够为相关应用提供稳定的MCP服务。

🚀 快速开始

# 安装依赖
npm install

# 构建项目
npm run build

✨ 主要特性

• 基于mcp - framework构建，具备良好的扩展性和稳定性。
• 提供了CLI工具，方便添加新的组件。
• 可与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

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 Framework Github
• MCP Framework 文档