README
🚀 Autodesk Alias API - MCP Server
这是一个MCP(模型上下文协议)服务器,它能让AI助手直接在Claude Desktop、Cursor或任何支持MCP的客户端工具中,对Autodesk Alias API文档进行搜索访问。
⚠️ 免责声明:这是一个非官方的社区项目,与Autodesk公司没有关联,也未得到其认可或支持。
🚀 快速开始
- 克隆并安装依赖项
git clone https://github.com/Roshan-RB/Autodesk_MCP.git
cd Autodesk_MCP
pip install -r requirements.txt
- 连接到你的AI工具 — 将服务器添加到你的MCP客户端配置中:
{
"mcpServers": {
"autodesk-alias-docs": {
"command": "/path/to/Autodesk_MCP/venv/Scripts/python.exe",
"args": ["/path/to/Autodesk_MCP/run_server_v3.py"]
}
}
}
请将/path/to/Autodesk_MCP替换为你实际的安装路径。
✨ 主要特性
- 该服务器能让AI助手在支持MCP的客户端工具中对Autodesk Alias API文档进行搜索访问。
- 服务器启动时会加载所有231个文档页面,去除不必要的数据以节省内存,并构建BM25搜索索引以实现快速、按相关性排序的检索。
- 提供四个工具,均有Pydantic验证的输入、工具注释和可选的JSON输出。
- 提供两个只读资源,用于轻量级的编程访问。
📦 安装指南
- 克隆并安装依赖项
git clone https://github.com/Roshan-RB/Autodesk_MCP.git
cd Autodesk_MCP
pip install -r requirements.txt
- 连接到你的AI工具 — 将服务器添加到你的MCP客户端配置中:
{
"mcpServers": {
"autodesk-alias-docs": {
"command": "/path/to/Autodesk_MCP/venv/Scripts/python.exe",
"args": ["/path/to/Autodesk_MCP/run_server_v3.py"]
}
}
}
请将/path/to/Autodesk_MCP替换为你实际的安装路径。
💻 使用示例
基础用法
search_alias_docs(query, max_results, response_format)
使用**BM25(Okapi)**排名在所有文档中进行搜索。搜索结果包含相关性得分、匹配的术语和内容片段。对于精确标题匹配和包含代码块的页面会应用启发式提升。
示例:search_alias_docs("create NURBS surface")
示例:search_alias_docs("AlCurve", response_format="json")
get_doc_by_title(title)
通过文档页面的标题(支持部分匹配)检索其完整内容。如果未找到匹配项,则返回标题建议。
示例:get_doc_by_title("AlCurve")
list_available_docs(limit, offset, category, response_format)
对所有文档页面进行分页列出。支持按类别(class表示API参考,guide表示教程/示例)进行过滤,并返回分页元数据(has_more,next_offset)。
示例:list_available_docs(category="class", limit=20)
示例:list_available_docs(offset=30, response_format="json")
get_code_examples(topic, max_results, response_format)
查找包含给定主题代码示例的文档页面。将搜索结果过滤为仅包含代码块的页面,非常适合查找示例插件和API使用模式。
示例:get_code_examples("plug-in")
示例:get_code_examples("NURBS", response_format="json")
📚 详细文档
MCP资源
两个只读资源,用于轻量级的编程访问:
docs://index— 所有页面的完整JSON索引(标题、GUID、URL、是否包含代码、类别)docs://stats— 语料库摘要(总页面数、类/指南/代码数量)
文档覆盖范围
抓取的数据集涵盖231个页面,包括:
- 类参考 — AlCurve、AlSurface、AlDagNode、AlUniverse等100多个类。
- 插件开发 — 瞬时、连续和命令历史记录插件。
- API示例 — 带有解释的完整代码示例。
- 实现指南 — 插件的编译、链接和设置。
后续计划
- 语义检索 — 用基于嵌入的搜索增强BM25,以获得更好的上下文感知结果。
- 基于上下文的工具选择 — 根据用户意图进行更智能的查询路由。
- 插件开发 — 构建由该MCP服务器驱动的真实Autodesk Alias插件。
📄 许可证
本项目提供了一个访问Autodesk Alias文档的工具。文档内容本身版权归Autodesk公司所有。有关文档许可,请参考Autodesk的使用条款。
Scan to join WeChat group