专业版MCP工具API文档生成提示词

角色定义与任务定位

请以资深技术文档工程师的身份，并兼任MCP（Model Context Protocol）工具架构师。你的核心目标是：根据给定的MCP工具功能描述与接口信息，生成一份专业、清晰、可直接用于开发集成的API参考文档。你的产出不是简单的功能罗列，而是具备标准结构、准确术语、实用示例的正式技术文档。

适用场景

• 为新建的MCP工具或Server编写初始API文档。
• 对现有MCP工具的API进行梳理和标准化。
• 生成面向开发者门户或SDK集成的参考手册部分。
• 创建与MCP协议规范对齐的工具说明文档。

核心提示词

以下提示词框架可直接复制并填充具体工具信息后使用：

• 基础指令： “作为MCP工具的技术文档工程师，请为名为‘[工具名称]’的MCP Server生成一份完整的API文档。该工具的主要功能是[简要描述核心功能，如：提供实时天气数据查询、执行代码分析等]。请遵循标准的API文档格式。”
• 结构化生成指令： “文档需包含以下章节：1. 概述（工具简介、协议兼容性）；2. 资源（Resources）列表与详细定义（包括名称、描述、输入Schema、输出Schema）；3. 工具（Tools）列表与详细定义（包括名称、描述、参数Schema）；4. 调用示例（包括cURL请求示例和客户端代码示例）；5. 错误码说明。请使用JSON Schema格式描述数据接口。”
• 风格与术语控制： “使用专业、客观、简洁的技术文档语言。术语必须与官方MCP协议规范保持一致。避免营销口吻和模糊描述。”

风格方向

• 语言风格： 正式、精确、无歧义。采用被动语态与现在时态。以“本文档描述…”、“该资源用于…”开头。
• 视觉隐喻（用于理解文档结构）： 将文档结构视为一个模块化的技术蓝图或清晰的电路图，每个接口都是标准化的连接节点。
• 色彩与质感联想： 联想到深色IDE背景上的高亮语法色（如蓝色关键字、绿色字符串）、灰色注释文本，以及单色图表线条，营造专业、专注、可读性强的感官氛围。

构图建议（文档结构布局）

• 层次结构： 采用“总-分-例”结构。顶部是工具概览和快速开始指南，中部是详细的资源/工具目录，底部是附录和示例。
• 信息密度： 保持高信息密度，但通过清晰的标题层级（H1, H2, H3）、列表和代码块进行视觉分隔。
• 焦点引导： 使用“注意”、“警告”等提示框突出关键约束、安全要求或常见错误。

细节强化

• Schema描述： 为每个资源的`input`/`output`和工具的`parameters`提供完整的JSON Schema定义，包括字段类型、是否必需、枚举值、默认值和示例值。
• 示例代码： 提供多语言调用示例（如Python、JavaScript），并确保示例中的认证、初始化步骤完整且可运行。
• 版本管理： 在文档开头明确标注基于的MCP协议版本（如v0.5.0）及工具自身的API版本。
• 可扩展提示： 可在核心指令后追加“请特别详细说明[某个复杂资源]的鉴权流程”或“请以表格形式对比不同参数组合的输出差异”。

使用建议

• 将“[工具名称]”和“[功能描述]”替换为您的实际内容，这是生成准确文档的基础。
• 生成初稿后，建议重点检查Schema定义是否与工具实际代码一致，示例代码是否可执行。
• 此提示词方案生成的文档可作为初稿，导入至Swagger UI、ReadTheDocs等平台进行进一步美化和发布。
• 对于复杂工具，可分段使用提示词，例如先生成资源列表，再针对每个资源生成详细定义。