Atlas Docs MCP服务器为AI助手提供库和框架的技术文档,将官方文档处理为适合LLM使用的Markdown版本,适用于Cursor、Cline、Windsurf等MCP兼容的LLM客户端。
文档处理服务
功能概述
文档处理服务是一项面向实际任务的技能,主要用于Atlas Docs MCP服务器为AI助手提供库和框架的技术文档,将官方文档处理为适合LLM使用的Markdown版本,适用于Cursor、Cline、Windsurf等MCP兼容的LLM客户端;⚠️ 强制要求:API 密钥;
核心要点
- 此 Skill 必须配置 API 密钥才能使用;
- 首次使用时,如果 .env 中没有 XBY_APIKEY , 必须使用 AskUserQues。
- 它将相关步骤、工具调用和结果整理方式集中到统一流程中,帮助使用者更快完成目标并减少重复操作。
使用与执行
从功能定位来看,该技能强调把分散的操作要求整理成清晰、可复用的处理流程,使用户能够围绕既定目标快速准备输入、选择执行方式并获得结构化结果。实际使用前应先确认任务范围、数据来源、运行环境、必要权限和关键参数,再依据技能说明逐步执行;若输入条件不完整,应先补齐信息或采用保守配置,避免因错误假设导致结果偏离需求。
结果检查与注意事项
执行过程中需要关注工具调用是否成功、接口或依赖是否可用、输出格式是否符合预期,并对异常提示、缺失字段和边界情况进行处理;涉及批量任务时,还应保存进度,避免中断后重复操作。该技能适合用于一次性任务,也可以接入自动化工作流,与其他技能或上层代理配合完成更完整的业务链路;在组合使用时,应明确每一步的输入输出关系,并避免不同步骤之间出现参数冲突。
文档处理服务
Atlas Docs MCP 服务器为 AI 助手提供库和框架的技术文档,将官方文档处理为适配 LLM 使用的 Markdown 格式,适用于 Cursor、Cline、Windsurf 等兼容 MCP 的 LLM 客户端。
⚠️ 强制要求: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数据整理后以清晰、易读的方式呈现给用户
工具选择规则
请根据用户意图选择对应的工具函数:
| 用户意图 | 工具函数 |
|---|---|
| 列出所有可用的文档库与框架。这是探索可用文档集的第一步,返回每个文档集的名称、描述及源 URL。在使用其他文档类工具前必须先调用本工具,因为后续操作需要 docName。 | scripts.tools.list_docs |
| 在指定文档集中搜索特定内容。适用于查找包含关键词、概念或主题的页面。返回按相关性排序的匹配页面,含路径与简要描述。后续可调用 get_docs_page 获取完整内容。 | scripts.tools.search_docs |
| 获取文档集内所有页面的精简版、LLM 友好型索引。适用于初步探索,帮助理解文档覆盖范围并识别相关页面。返回一个 Markdown 格式的页面,其中包含所有可用页面的列表。后续可调用 get_docs_page 获取完整内容。 | scripts.tools.get_docs_index |
| 根据相对路径获取某篇具体文档页面的内容。适用于已通过 get_docs_index 或 search_docs 锁定目标页面后,进一步获取详细信息。返回单个文档页面的全部内容。 | scripts.tools.get_docs_page |
| 以单个整合文件形式获取整套文档的全部内容。适用于需要全面知识或需分析完整上下文的场景。返回大量文本——如仅需特定信息,请优先考虑 get_docs_page 或 search_docs。 | scripts.tools.get_docs_full |
若参数不完整,必须使用 AskUserQuestion 向用户询问缺失参数。
工具函数说明
scripts.tools.list_docs
工具描述:列出所有可用的文档库与框架。这是探索可用文档集的第一步,返回每个文档集的名称、描述及源 URL。在使用其他文档类工具前必须先调用本工具,因为后续操作需要 docName。
参数定义
| 参数名称 | 参数类型 | 是否必填 | 默认值 | 描述 |
|---|
scripts.tools.search_docs
工具描述:在指定文档集中搜索特定内容。适用于查找包含关键词、概念或主题的页面。返回按相关性排序的匹配页面,含路径与简要描述。后续可调用 get_docs_page 获取完整内容。
参数定义
| 参数名称 | 参数类型 | 是否必填 | 默认值 | 描述 |
|---|---|---|---|---|
| docName | string | true | 文档集的名称 | |
| query | string | true | 在文档集中搜索相关内容的查询语句 |
scripts.tools.get_docs_index
工具描述:获取文档集内所有页面的精简版、LLM 友好型索引。适用于初步探索,帮助理解文档覆盖范围并识别相关页面。返回一个 Markdown 格式的页面,其中包含所有可用页面的列表。后续可调用 get_docs_page 获取完整内容。
参数定义
| 参数名称 | 参数类型 | 是否必填 | 默认值 | 描述 |
|---|---|---|---|---|
| docName | string | true | 文档集的名称 |
scripts.tools.get_docs_page
工具描述:根据相对路径获取某篇具体文档页面的内容。适用于已通过 get_docs_index 或 search_docs 锁定目标页面后,进一步获取详细信息。返回单个文档页面的全部内容。
参数定义
| 参数名称 | 参数类型 | 是否必填 | 默认值 | 描述 |
|---|---|---|---|---|
| docName | string | true | 文档集的名称 | |
| pagePath | string | true | 目标文档页面的根路径(例如:'/guides/getting-started'、'/api/authentication') |
scripts.tools.get_docs_full
工具描述:以单个整合文件形式获取整套文档的全部内容。适用于需要全面知识或需分析完整上下文的场景。返回大量文本——如仅需特定信息,请优先考虑 get_docs_page 或 search_docs。
参数定义
| 参数名称 | 参数类型 | 是否必填 | 默认值 | 描述 |
|---|---|---|---|---|
| docName | string | true | 文档集的名称 |
返回值处理
工具函数统一返回 dict 类型对象:
result["raw"]—— API 原始响应数据(JSON 格式),请直接整理该字段内容并展示给用户result["success"]—— 执行是否成功(True/False)result["message"]—— 状态提示信息
项目结构
xiaobenyang_gaokao_skill/ ├── scripts/ │ ├── __init__.py │ ├── config.py # 配置管理模块 + set_api_key() │ ├── call_api.py # API 客户端模块 + call_api() │ └── tools.py # 工具函数模块(直接封装并调用 API) ├── requirements.txt └── SKILL.md
注意事项
- API 密钥为必需项,无密钥时必须通过 AskUserQuestion 主动向用户索取
- 禁止在缺少 API 密钥的情况下自行搜索或编造任何数据
相关专题
本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。
0
2026.11.06
围绕Postman HTTP请求头配置展开,讲解Headers选项的具体使用方式,包括Key和Value参数填写、请求头信息添加、常见Header字段设置及请求头修改方法,帮助用户解决接口调试过程中遇到的请求头配置问题。
0
2026.11.06
详细介绍Postman接口请求的创建与发送方法,涵盖GET和POST请求、URL配置、请求参数、Headers请求头、Body请求体设置以及响应结果查看,帮助用户掌握Postman接口请求的完整操作流程。
0
2026.11.06
DBeaver数据导入专题,整理Excel、CSV、SQL、TXT等常见文件的数据导入方法,涵盖目标数据库选择、数据表创建、字段映射、数据类型设置及导入参数配置等操作,帮助用户将本地文件中的数据写入数据库,并了解批量导入、重复数据处理和导入失败等常见问题的解决方法。
0
2026.11.05
DBeaver安全防护专题,围绕数据库连接安全、账号密码保护和访问权限管理展开,整理SSL/TLS加密连接、SSH隧道、数据库凭据保存及证书验证等配置方法,同时介绍敏感信息保护、远程连接风险和高权限账号使用等注意事项,帮助用户提高数据库日常管理的安全性。
0
2026.11.05
本专题聚焦DBeaver数据库连接配置与管理,覆盖从新建连接、选择数据库类型到填写连接参数和验证连接的完整流程。针对MySQL、PostgreSQL、SQL Server等常见数据库,整理相应的连接设置方法,并提供驱动缺失、认证失败和连接异常等问题的排查方向。
0
2026.11.04
本专题围绕XORM框架的结构体映射展开,说明表名与字段的命名策略、xorm标签常用属性、主键自增与时间字段自动填充,并演示Sync2自动建表、增量字段升级、索引声明与反向生成结构体的完整流程。
0
2026.11.04
本专题聚焦XORM框架的配置与连接环节,拆解MySQL、PostgreSQL、SQLite、SQL Server的DSN写法与驱动选择,讲清连接池参数、多数据源拆分、读写分离与超时重连的处理方式,并补充容器与兼容数据库的适配经验。
0
2026.11.04
本专题聚焦XORM框架的配置与连接环节,拆解MySQL、PostgreSQL、SQLite、SQL Server的DSN写法与驱动选择,讲清连接池参数、多数据源拆分、读写分离与超时重连的处理方式,并补充容器与兼容数据库的适配经验。
0
2026.11.04
热门下载
相关下载
精品课程
共6课时 | 12.1万人学习
共79课时 | 161.8万人学习
共6课时 | 54.7万人学习
最新文章