文档导航服务
一个帮助AI助手高效导航ANSYS Fluent在线文档的模型上下文协议(MCP)服务器,提供智能URL导航、预映射主题路径和官方文档链接。
⚠️ 强制要求:API 密钥
此 Skill 必须配置 API 密钥才能使用。
- 首次使用时,如果
.env中没有XBY_APIKEY,必须使用 AskUserQuestion 工具向用户询问 API 密钥 - 拿到用户提供的密钥后,调用
scripts.config.set_api_key(api_key)保存,然后继续处理 - 获取 API 密钥:https://xiaobenyang.com
- 禁止在缺少 API 密钥时自行搜索或编造数据
工作流程(必须遵守)
你(大模型)是路由层,负责理解用户意图、选择工具、提取参数。代码只负责调用API。
用户输入 → 你选择工具 → 提取该工具需要的参数 → 调用 scripts.tools 中的函数 → 返回结果给用户
步骤
- 检查 API 密钥:如果
scripts.config.settings.api_key为空,使用 AskUserQuestion 询问用户,拿到后调用scripts.config.set_api_key(key)保存 - 选择工具:根据用户意图从下方工具列表中选择对应的工具函数
- 提取参数:根据选中的工具,提取该工具需要的参数
- 调用工具:使用关键字参数调用
scripts.tools中的函数,例如scripts.tools.search_schools(score='520', province='北京', category='综合') - 返回结果:将工具返回的
raw数据整理后展示给用户
工具选择规则
根据用户意图选择对应的工具函数:
| 用户意图 | 工具函数 | |---------|---------| | Find ANSYS Fluent documentation URLs for your query.
This tool helps you navigate to the right online documentation. Use WebFetch to retrieve the actual content from the returned URLs.
Args: query: Search term (e.g., "flamelet model", "read case", "turbulence") max_suggestions: Maximum manual section suggestions to return (default: 3)
Returns:
URLs and navigation hints for finding the documentation | scripts.tools.search_help |
| List common Fluent topics with quick documentation links.
Returns:
List of pre-mapped topics for faster navigation | scripts.tools.list_topics |
| Get direct link to a specific Fluent manual or section.
Args: manual: Manual name (user_guide, tui, theory, udf) section: Optional section path (e.g., "turbulence", "file/read-case")
Returns:
Direct URL to the manual or section | scripts.tools.get_manual_link |
如果参数不完整,使用 AskUserQuestion 向用户询问缺失的参数。
工具函数说明
scripts.tools.search_help
工具描述:Find ANSYS Fluent documentation URLs for your query.
This tool helps you navigate to the right online documentation. Use WebFetch to retrieve the actual content from the returned URLs.
Args: query: Search term (e.g., "flamelet model", "read case", "turbulence") max_suggestions: Maximum manual section suggestions to return (default: 3)
Returns: URLs and navigation hints for finding the documentation
参数定义
|参数名称|参数类型|是否必填|默认值|描述| |------|-------|------|-----|----| |query|string|true| |null| |max_suggestions|integer|false|3.0|null|
scripts.tools.list_topics
工具描述:List common Fluent topics with quick documentation links.
Returns: List of pre-mapped topics for faster navigation
参数定义
|参数名称|参数类型|是否必填|默认值|描述| |------|-------|------|-----|----|
scripts.tools.get_manual_link
工具描述:Get direct link to a specific Fluent manual or section.
Args: manual: Manual name (user_guide, tui, theory, udf) section: Optional section path (e.g., "turbulence", "file/read-case")
Returns: Direct URL to the manual or section
参数定义
|参数名称|参数类型|是否必填|默认值|描述| |------|-------|------|-----|----| |manual|string|true| |null| |section|null|false| |null|
返回值处理
工具函数返回 dict 对象:
result["raw"]- API 原始返回数据(JSON),直接将此数据整理后展示给用户result["success"]- 是否成功(True/False)result["message"]- 状态消息
项目结构
./
├── scripts/
│ ├── __init__.py
│ ├── config.py # 配置管理 + set_api_key()
│ ├── call_api.py # API 客户端 + call_api()
│ └── tools.py # 工具函数(直接调用)
├── requirements.txt
└── SKILL.md
注意事项
- API 密钥是必需的,无密钥时必须通过 AskUserQuestion 询问用户
- 禁止在缺少 API 密钥时自行搜索或编造数据
微信扫一扫