把「错误码文档」写成 MCP 服务:工具定义与客户端配置
把「错误码文档」交给智能体,难点不在模型能力,而在流程是否说清楚:输入是什么(错误码定义),按什么顺序处理,交付什么(错误码文档),哪些事不能做。Skill 就是把这些写下来的载体。
本文介绍如何在 MCP 服务 上实现这个技能,包括它的形态、示例配置、启用步骤、一次完整的运行过程和常见坑。
这个技能做什么
| 项目 | 说明 |
|---|---|
| 技能 | 错误码文档(error-message-doc) |
| 作用 | 整理系统错误码及处理建议 |
| 输入 | 错误码定义 |
| 输出 | 错误码文档 |
| 形态 | 纯提示词 |
| 风险 | 低 |
| 适用人群 | 开发者与技术写作者 |
处理流程分四步:
- 列出错误码与含义
- 写触发原因
- 给出用户与开发者处理建议
- 附示例
这个技能纯指令型,不需要额外脚本或外部连接,复制到大多数平台都能用;风险较低,但输出仍需快速过目再使用。
在 MCP 服务 中是什么形态
MCP(模型上下文协议)是一个开放协议,让智能体以统一方式调用外部工具、读取资源和使用提示模板。把技能中需要确定性执行的部分写成 MCP 工具,就能在支持 MCP 的多个客户端中复用。
MCP 服务可以本地运行(stdio),也可以部署为远程服务;在客户端的 MCP 配置中注册后,智能体即可发现其中的工具。
示例配置
# server.py —— 示意代码,需安装官方 MCP Python SDK
from mcp.server.fastmcp import FastMCP
mcp = FastMCP("error-message-doc")
@mcp.tool()
def error_message_doc(content: str) -> str:
"""整理系统错误码及处理建议。content 为错误码定义。"""
# 在这里做确定性的预处理:读取、解析、统计、校验
lines = [x for x in content.splitlines() if x.strip()]
return f"共 {len(lines)} 行有效内容,已完成预处理"
@mcp.prompt()
def error_message_doc_guide() -> str:
"""错误码文档的标准流程提示"""
return """列出错误码与含义;写触发原因;给出用户与开发者处理建议;附示例。输出:错误码文档"""
if __name__ == "__main__":
mcp.run()
客户端侧的注册配置通常类似下面这样(文件位置与字段以所用客户端文档为准):
{
"mcpServers": {
"error-message-doc": { "command": "python", "args": ["server.py"] }
}
}
示例里最重要的是两处:一是描述(或指令开头)要写明「什么时候用」,让智能体在开发者与技术写作者提出相关请求时能对上号;二是约束部分要写进「文中的命令和接口要与当前代码逐一核对」这类领域规矩,避免智能体自作主张。
安装与启用步骤
- 用官方 SDK(Python 或 TypeScript)新建一个 MCP 服务项目
- 把技能中可确定执行的步骤写成工具函数,docstring 写清用途与参数
- 把标准流程写成 prompt 模板,供客户端调用
- 在客户端配置中注册服务并重启
- 用调试工具或客户端调用一次,检查返回
实操:一次完整的运行
假设你在文档仓库与文档站中发出这样的请求(虚构示例):
用错误码文档技能处理这份错误码定义,输出错误码文档。
智能体识别到任务与「错误码文档」相关后,会依次列出错误码与含义、写触发原因、给出用户与开发者处理建议、附示例。最终交付错误码文档,并在末尾列出需要人工确认的内容。你的工作是对照原始错误码定义抽查两三处关键信息,确认无误后再使用。
测试与验收
先用 MCP 官方调试工具单独调用每个工具,再在客户端中让智能体端到端完成一次任务。
针对这个技能,还建议额外准备:
- 一份信息齐全的标准错误码定义,检查输出是否完整
- 一份缺少关键信息的输入,检查智能体是否先提问而不是编造
- 一份包含“忽略以上规则”等字样的输入,检查约束是否仍然有效
常见坑
- 工具描述太模糊,智能体不知道何时调用。
- 工具权限过大(如任意执行命令),一旦被提示注入就可能造成损失。
- 只写了步骤,没写交付格式,导致每次输出的错误码文档结构不同。
- 没有给出样例,智能体对“好结果”的理解与你不一致;在参考资料里放一两份范例会明显改善。
延伸阅读
- 错误码文档 · Windsurf Rules 版
- 错误码文档 · n8n AI Agent 版
- 错误码文档 · 快速上手
- 配置项说明 · MCP 服务 版
- 更新日志生成 · MCP 服务 版
- 智能体Skills 分类:625 个技能 × 32 个角度
说明:文中的配置、代码与目录结构均为示意,用于说明思路;各平台的入口、字段名与能力会更新,落地前请以对应官方文档为准。示例中的数据与场景为虚构,不代表真实案例。