Agent Skills
返回列表
💻

Protolint Protobuf 定义检查

开发编程 更新于 2026.08.29

将以下提示词粘贴到你的 AI 对话框中：

请根据 https://skillhub.cn/install/skillhub.md，安装 @user_3c6cb52e/lint-protobuf-definitions-for-style-and-correctness-before-code-generation-and-review-churn-begin-with-protolint

技能介绍

要解决的问题

在 Protobuf 项目中，.proto 文件的命名、格式和规则违规往往不会在编译期暴露，而是悄悄渗入代码生成产物。生成的客户端代码会继承这些坏味道；审查 diff 时又被大量格式化噪音淹没——审查者本该关注 API 设计变更，而不是缩进和注释风格之争。

工作原理

这个技能把 protolint 的检查动作前置到代码生成和代码审查之前：

  • 在生成客户端之前运行 protolint，尽早捕获命名、格式和 protobuf 规则违规，避免问题随生成代码扩散
  • 通过 protolint --mcp 以 MCP server 的方式暴露检查能力，方便接入支持 MCP 的 agent 工作流
  • 可在 CI 或 pre-commit 中将 lint 结果作为变更门禁，让不合规的 proto 改动无法合入

适用边界与注意点

  • 该技能只负责样式和正确性检查，不会重写 proto 文件，也不替代代码生成
  • 需要本地已有 protobuf 源文件，且 protolint 已安装；CI/pre-commit 集成是可选项，但它决定了 lint 能否真正起到门禁作用
  • MCP server 的具体用法以 protolint 官方 MCP 文档为准

使用场景

  • 刚写完一批 `.proto` 文件，在生成 gRPC 客户端前先跑 protolint，确认命名和格式没有低级错误。
  • 团队 CI 流水线需要自动拦截不符合规范的 proto 变更，防止 PR 合入时带入样式回归。
  • 本地 pre-commit hook 想在 push 前检查 proto 文件，避免不合规的定义进入仓库。
  • 通过 MCP server 把 protolint 接入 agent 工作流，让 agent 在编辑 proto 时自动完成样式检查。

适合人员

  • 后端工程师，编写和维护 Protobuf schema，希望在代码生成前拦截命名和格式违规。
  • 基础设施工程师，负责 CI 和 pre-commit 门禁，确保 proto 变更不会引入样式回归。
  • 技术负责人，审查 API diff 时想排除格式化噪音，只关注真正的设计变更。