使用说明
项目简介
Grasshopper MCP Server 是一个基于 Model Context Protocol (MCP) 构建的后端服务,旨在为 LLM 客户端提供与 Rhino 和 Grasshopper 进行交互的能力。它允许通过标准化的 MCP 协议,利用 Grasshopper 的强大参数化建模和分析功能。
主要功能点
- 资源管理: 提供对 Rhino 文件的信息查询和对象数据访问。
- 工具调用: 注册了多种 Grasshopper 工具,例如几何体提取、距离测量、Grasshopper 代码生成、组件操作、定义运行等,允许 LLM 客户端调用这些工具来执行 Rhino 和 Grasshopper 操作。
- Prompt 模板: 支持 Prompt 模板,以便定制与 LLM 的交互模式,例如创建参数化模型。
安装步骤
- 环境准备: 确保已安装 Python 环境。建议使用虚拟环境以隔离依赖。
- 安装依赖: 使用 pip 或 uv 安装项目依赖。虽然仓库中没有明确的 requirements.txt,但根据代码内容,可能需要安装 'mcp-server', 'python-dotenv', 'rhino3dm' (如果使用 rhino3dm 模式) 或 'rhinoinside' (如果使用 RhinoInside 模式)。具体安装命令需要用户根据实际情况确定,例如 'pip install mcp-server python-dotenv rhino3dm'。
服务器配置
MCP 客户端需要配置 MCP 服务器的启动命令 (command) 及其参数 (args) 才能与 MCP 服务器建立连接。以下是 Grasshopper MCP 服务器的配置信息示例 (JSON 格式):
{ "server name": "grasshopper", "command": "python", "args": ["grasshopper_mcp/server.py"] }
配置信息 (JSON 格式) 用于 MCP 客户端连接 Grasshopper MCP 服务器。
- 'server name': 服务器名称,客户端用于标识和连接。例如 '"grasshopper"'。
- 'command': 启动服务器的命令。通常为 Python 解释器路径,例如 '"python"' 或 Python 虚拟环境的 Python 路径。
- 'args': 启动命令的参数列表。指定服务器启动脚本路径,例如 '["grasshopper_mcp/server.py"]'。
MCP 客户端需要配置以上 JSON 信息以连接到 Grasshopper MCP 服务器。
基本使用方法
- 启动服务器: 在仓库根目录下,运行 'python grasshopper_mcp/server.py' 启动 Grasshopper MCP 服务器。
- 配置 MCP 客户端: 在 MCP 客户端中,配置上述 JSON 格式的服务器连接信息。
- 使用 MCP 客户端: 通过 MCP 客户端发送请求,例如查询 Rhino 文件信息、调用 Grasshopper 工具等,与 Grasshopper 进行交互。
信息
分类
桌面与硬件