使用说明

项目简介

CadQuery MCP Server 是一个基于 Model Context Protocol (MCP) 构建的后端服务器，它将 CadQuery 的 3D 建模功能通过标准化的 MCP 协议暴露给客户端（如 AI 助手）。该服务器允许客户端执行 CadQuery 脚本，生成 3D 模型，导出模型为多种格式，并管理一个可搜索的 CadQuery 零件库。

主要功能点

执行 CadQuery 脚本: 客户端可以发送 CadQuery 代码到服务器执行，并获取结果。
导出 3D 模型: 支持导出生成的 3D 模型为 STEP, STL 等格式，以及 SVG 预览图。
零件库管理: 可以组织和搜索 CadQuery 零件库，方便模型复用和管理。
HTTP SSE 和 Stdio 两种模式: 支持 HTTP Server-Sent Events (SSE) 和 Stdio 两种通信模式，满足不同客户端的需求。
自动环境配置: 首次运行时自动创建 Python 虚拟环境并安装所需依赖。

安装步骤

前提条件: 确保已安装 'git', 'python3' (3.10+), 和 'uv'。
克隆仓库: 在终端中执行命令 'git clone <repository-url> && cd mcp-cadquery'，将仓库克隆到本地并进入目录。
运行服务器: 根据需要选择运行脚本：
- HTTP SSE 模式 (推荐): 执行 './server_sse.sh' (默认端口 8000)。
- Stdio 模式: 执行 './server_stdio.sh' (用于直接客户端集成)。
- (首次运行脚本会自动设置 Python 环境)

服务器配置

MCP 服务器可以通过命令行参数进行配置。以下是针对不同模式的 MCP 客户端配置示例，用户需要根据实际使用的客户端进行配置，并根据需要调整 'args' 中的参数。

HTTP SSE 连接配置 (例如 RooCode 客户端):

{
  "mcpServers": {
    "cadquery_sse": {
      "name": "CadQuery Server (SSE)",
      "url": "http://127.0.0.1:8000/mcp",
      "alwaysAllow": [
        "execute_cadquery_script", "export_shape_to_svg", "scan_part_library", "search_parts", "export_shape"
      ]
    }
  }
}

'name': 服务器显示名称 (可选)。
'url': MCP 服务器的 URL 地址，默认为 'http://127.0.0.1:8000/mcp'。如果使用 '--port' 参数修改了端口，请相应地调整此 URL。
'alwaysAllow': 允许客户端无需确认即可使用的工具列表 (可选)。

运行命令 (终端): './server_sse.sh [OPTIONS]' (例如，'./server_sse.sh --reload')

Stdio 连接配置 (例如 RooCode 客户端):

{
  "mcpServers": {
    "cadquery_stdio": {
      "name": "CadQuery Server (Stdio)",
      "command": "./server_stdio.sh",
      "args": [
         "--library-dir", "my_cq_workspace",
         "--preview-dir-name", ".previews"
      ],
      "alwaysAllow": [
         "execute_cadquery_script", "export_shape_to_svg", "scan_part_library", "search_parts", "export_shape"
      ]
    }
  }
}

'name': 服务器显示名称 (可选)。
'command': 启动 MCP 服务器的命令，直接使用 './server_stdio.sh' 脚本。
'args': 传递给服务器启动脚本的命令行参数列表 (可选)。
- '"--library-dir", "my_cq_workspace"': 指定零件库目录，默认为 'part_library/'。
- '"--preview-dir-name", ".previews"': 指定预览图目录名称，默认为 '.previews'。
'alwaysAllow': 允许客户端无需确认即可使用的工具列表 (可选)。

运行命令: 由 MCP 客户端根据配置的 'command' 和 'args' 自动管理。首次启动时，客户端会自动设置环境。

基本使用方法

启动 MCP 服务器 (根据选择的模式)。
配置 MCP 客户端连接到服务器。
在 MCP 客户端中，可以使用提供的工具与 CadQuery 服务器交互，例如：
- 使用 'execute_cadquery_script' 工具执行 CadQuery 代码并生成 3D 模型。
- 使用 'export_shape_to_svg' 工具导出模型预览图。
- 使用 'export_shape' 工具导出模型为 STEP/STL 文件。
- 使用 'scan_part_library' 工具扫描零件库。
- 使用 'search_parts' 工具搜索零件库中的零件。

详细的工具使用方法和参数说明请参考仓库 README.md 文件中的 "MCP Tools Provided" 章节。

关键词

使用说明

信息