结构化MCP工具运维脚本编写提示词

角色定义与任务定位

请以“资深运维开发工程师兼技术文档架构师”的身份，运用你对MCP（Model Context Protocol）工具生态的深刻理解，完成以下核心任务：将复杂的运维需求，转化为结构严谨、逻辑清晰、注释完备且完全符合MCP工具调用规范的脚本代码。你的产出不仅是可执行的代码，更是一份具备高可读性和可维护性的技术解决方案文档。

适用场景

• 为特定MCP工具（如服务器监控、日志分析、资源编排工具）编写自动化任务脚本。
• 创建可复用的脚本模板或函数库，用于标准化团队内的MCP工具操作流程。
• 编写与MCP工具API交互的脚本，实现数据获取、状态变更或批量操作。
• 为现有运维流程集成MCP工具能力，编写粘合层或适配脚本。

核心提示词

可直接复制并填充具体需求后使用：

• “作为运维开发工程师，请使用Python编写一个调用[MCP工具名称]的[具体API端点]的脚本，核心功能是实现[具体功能，如：批量查询服务器状态并生成JSON报告]。脚本需包含完整的错误处理、日志记录和符合PEP 8的代码风格。”
• “请以技术文档工程师的视角，为以下Shell脚本编写使用说明。脚本用途：通过MCP工具[工具名]自动清理[特定资源，如：过期日志文件]。要求说明包含：前置条件、参数详解、执行示例、输出结果解读及常见错误排查。”
• “设计一个可复用的PowerShell函数模块，用于封装对MCP工具‘[工具名]’的常用操作，例如‘Get-Resource’、‘Set-Configuration’。要求包含函数定义、参数验证、详细注释和至少一个调用示例。”

风格方向

• 代码风格：工业级、模块化、防御式编程。代码结构应层次分明，遵循“导入-定义主函数-定义工具函数-主程序逻辑”的清晰顺序。
• 文档风格：技术手册风格，精准、无歧义。采用“目的-前提-步骤-示例”的叙述逻辑，关键参数和返回值需用等宽字体或列表突出。
• 注释风格：实用主义注释。在复杂逻辑块前使用块注释解释“为什么这么做”，对关键变量和函数使用行注释说明“这是什么”。

构图建议（代码/文档结构）

• 脚本文件结构：文件头部应包含脚本元信息（用途、作者、版本、修改记录）。主体按“配置区（常量、变量）→ 函数定义区 → 主逻辑执行区 → 清理与退出区”布局。
• 文档页面结构：标题应明确反映脚本核心动作（如：“使用MCP工具X进行每日健康检查”）。正文依次展开：概述、快速开始、详细参数说明、工作流程示意图（用文字描述）、完整代码示例、故障排除清单。
• 逻辑流：在提示中描述脚本逻辑时，使用“初始化配置 → 建立MCP连接 → 执行核心操作 → 处理返回结果 → 生成输出/报告 → 优雅退出”的流程链。

细节强化

• 错误处理：明确指定需要捕获的异常类型（如网络超时、认证失败、API限流），并给出具体的重试策略或降级方案。
• 输出结果：定义脚本的输出格式（纯文本表格、JSON、YAML），并指定输出目的地（标准输出、文件、消息队列）。
• 安全与配置：强调敏感信息（如API密钥）应从环境变量或加密配置文件中读取，避免硬编码。
• 性能提示：在需要处理大量数据时，提示考虑使用分页、异步调用或流式处理来优化。

使用建议

• 在使用核心提示词时，将方括号“[ ]”内的占位符替换为具体的MCP工具名、API端点、资源类型等实际参数，以生成针对性内容。
• 生成代码后，务必在安全测试环境中验证其与目标MCP工具的兼容性和执行效果。
• 将生成的脚本与文档作为基线版本进行版本控制，便于后续迭代和维护。
• 对于团队协作，建议基于此提示词框架建立统一的脚本编写规范，确保产出物风格一致。