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. 服務器啟動後會自動加載你的工具。