高阶版MCP工具API封装说明提示词
本提示词方案旨在帮助技术文档工程师或API开发者,以清晰、专业且结构化的方式,生成“高阶版MCP...
提示词内容
复制角色定义与任务定位
请以“技术文档架构师”兼“开发者体验设计师”的身份,执行本次内容生成任务。你的核心目标是:为“高阶版MCP工具”的API封装层,创作一份逻辑清晰、视觉友好、便于开发者快速理解与集成的结构化说明文档。这份文档不仅是技术规格的罗列,更是提升工具易用性与团队协作效率的关键资产。
适用场景
- 为新版MCP工具编写对外发布的API参考文档。
- 为内部开发团队提供封装规范的统一说明。
- 制作技术方案PPT或产品介绍中的工具集成部分。
- 生成用于自动化文档站点的结构化内容源。
核心提示词
以下提示词组合可直接用于引导生成或作为文档章节骨架:
- “高阶版MCP工具API封装层:核心接口与调用流程详解”
- “结构化封装说明:从认证初始化到工具调用的完整代码示例”
- “MCP工具API封装设计:错误处理、状态管理与性能优化指南”
- “工具调用封装模块:参数结构化规范、响应数据模型与版本兼容性说明”
风格方向
- 专业极简风:采用清晰的层级划分(如H1/H2/H3标题)、代码高亮块、信息表格,避免冗余装饰。
- 技术图解风:结合序列图、架构框图(可文字描述其结构),可视化展示请求/响应流与模块关系。
- 代码注释风:以关键代码片段为核心,辅以行内注释和段落说明,模拟优秀开源项目的README风格。
构图建议
- 信息层级构图:将文档视为一个从上至下的信息流,顶部是概述与快速开始,中部是核心API详解,底部是附录与常见问题。
- 对比与聚焦:使用“代码块”与“说明文本”的强烈对比来突出重点。关键参数或警告信息可使用视觉徽章(如[必需]、[推荐])进行标注。
- 留白与呼吸感:在章节之间、代码示例与正文之间保留足够的视觉间距,避免信息过载。
细节强化
- 色彩与标识:为不同的代码语言(如Python/JavaScript)、请求/响应类型、状态码建议主题色,保持全文一致。
- 材质与质感
- 色彩与标识:为不同的代码语言(如Python/JavaScript)、请求/响应类型、状态码建议主题色,保持全文一致。
- 材质与质感:代码块背景采用深色微磨砂质感,与浅色正文背景形成舒适对比。关键术语可轻微加粗或使用等宽字体。
- 动态元素暗示:在描述“调用流程”时,使用“→”、“⇒”等箭头符号构建视觉动线;用“【模块A】”这样的框式强调来模拟组件感。
- 精准术语:严格统一使用“封装器(Wrapper)”、“端点(Endpoint)”、“负载(Payload)”、“结构化参数”等术语,避免口语化混淆。
使用建议
- 将“核心提示词”中的任一语句作为生成任务的起点,可获得一份完整的文档草稿。
- 在“风格方向”中选择一种作为主要基调,并混合其他风格的优点(如极简风中加入少量图解)。
- 生成内容后,请人工复核技术细节的准确性,并根据“细节强化”项进行视觉排版优化,插入真实的代码示例。
- 此方案同样适用于指导AI生成分章节内容,可针对“认证”、“工具调用示例”、“错误码列表”等子模块分别应用本结构。