Kam MCP Server

🚀 kam-mcp-server 中文版

一个使用 mcp-framework 构建的模型上下文协议（MCP）服务器，可助力相关模型的上下文处理。

🚀 快速开始

以下是项目启动的基本步骤：

# 安装依赖项
npm install

# 构建项目
npm run build

✨ 主要特性

该项目具备丰富的工具和资源，可用于模型上下文协议相关操作，如创建不同类型的元素、获取视图元素、获取可用族类型、删除元素等。

📦 安装指南

安装依赖

npm install

构建项目

npm run build

📚 详细文档

项目结构

kam-mcp-server/
├── build/                  # 构建输出目录
├── src/
│   ├── tools/             # MCP 工具
│   │   └── CreatePointBasedElementTool.ts    # 基于点的元素创建工具
│   │   └── CreateLineBasedElementTool.ts     # 基于线的元素创建工具
│   │   └── CreateSurfaceBasedElementTool.ts  # 基于面的元素创建工具
│   │   └── GetCurrentViewElementsTool.ts      # 获取当前视图元素工具
│   │   └── GetAvailableFamilyTypesTool.ts     # 获取可用族类型工具
│   │   └── DeleteElementTool.ts               # 删除元素工具
│   │   └── GetElementByIdTool.ts              # 通过 ID 获取元素工具
│   ├── resources/         # MCP 资源
│   │   └── KamDocResourceResource.ts         # Kam 文档资源
│   └── index.ts           # 服务器入口文件
├── package.json            # 项目依赖和配置
└── tsconfig.json           # TypeScript 配置文件

发布到 npm

1. 更新 package.json：
   • 确保 name 唯一且符合 npm 命名规范。
   • 设置合适的 version。
   • 添加 description、author、license 等信息。
   • 检查 bin 是否指向正确的入口文件。
2. 本地构建并测试：

   yarn build
   npm link
   kam-mcp-server          # 本地测试 CLI
   

3. 登录 npm（如无账号需先创建）：

   npm login
   

4. 发布你的包：

   npm publish
   

发布后，用户可以通过以下方式使用：添加到 Claude Desktop 客户端或通过 npx 运行。

在 Claude Desktop 上使用

发布后的配置

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

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

{
  "mcpServers": {
    "kam-mcp-server": {
      "command": "npx",
      "args": ["-y", "kam-mcp-server", "--port=9099"]
    }
  }
}

构建和测试

1. 修改你的工具文件。
2. 运行 yarn build 进行构建。
3. 服务器启动后会自动加载你的工具。