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