protobuf

Guide proto design, validation, and buf-based verification workflows.

Updated Apr 17, 2026
One-click install
npx skills add https://github.com/Manu343726/audible-exporter --skill protobuf-manu343726
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: protobuf
Source: https://github.com/Manu343726/audible-exporter/tree/main/.agents/skills/protobuf
Command: npx skills add https://github.com/Manu343726/audible-exporter --skill protobuf-manu343726

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes assets (resource) and references (resource) components.

What problem does it solve?

This Skill helps you create, validate, and safely evolve Protocol Buffer schemas so you avoid breaking client compatibility and reduce time spent on buf lint/breaking/format issues.

Core Features & Use Cases

  • Proto design with guardrails: Apply consistent file structure, naming conventions, field numbering rules, and documentation practices.
  • Validation-first schemas: Add protovalidate constraints to every field (including oneof required patterns) to make the schema the single source of truth.
  • buf workflow automation: Use the standard sequence of format, lint, breaking checks, and (when needed) generation/dependency steps to keep changes safe and reviewable.
  • Schema evolution safety: Reserve removed fields/enums, avoid wire-breaking edits, and verify breaking changes against a known baseline.

Quick Start

Ask the protobuf skill to help you update an existing API by adding a new field with correct numbering and protovalidate constraints, then validate it by running buf format and buf lint and checking compatibility with buf breaking.

Frequently Asked Questions about protobuf

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I prevent breaking changes when evolving a protobuf schema?

To prevent breaking changes in a protobuf schema, reserve removed fields and enums, avoid wire-breaking edits, and run buf breaking checks against a known baseline. This verifies compatibility and prevents incompatible schema evolution.

How do I add protovalidate constraints to enforce protobuf field correctness?

Add protovalidate constraints directly to your protobuf fields, including oneof required patterns, to make the schema the single source of truth for runtime correctness. This enforces validation without needing separate manual checks.

What is the standard buf workflow for validating .proto files?

The standard buf workflow for validating .proto files involves running buf format, buf lint, and buf breaking checks after changes. This sequence keeps schema modifications safe, consistent, and reviewable before generation.

How do I configure buf.yaml and buf.gen.yaml for gRPC service development?

Configure buf.yaml and buf.gen.yaml to define module dependencies and generation plugins for gRPC and Connect services. This setup enables proper buf linting, formatting, and code generation workflows for your protobuf APIs.

What protobuf naming conventions and field numbering rules should I follow?

Follow consistent file structure, naming conventions, and field numbering rules during protobuf design to maintain API reliability. Using buf lint after changes verifies that your schemas adhere to these required conventions.