set_branch_protection

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description bears full responsibility. It states the operation type (write) and lists multiple behaviors: requires PR approvals, optional code owner review, blocks force-push/deletion, requires conversation resolution and linear history. It also mentions the environment variable gate. It does not clarify whether the policy replaces or merges with existing rules, but the 'baseline' term implies a fresh set.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is concise, front-loading the purpose in the first sentence. It uses a separate line for the operation type and the condition. Every sentence adds value, though a structured list of effects might improve readability.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given 6 parameters, no output schema, and no annotations, the description covers the main purpose and effects but lacks parameter details and return value. It provides enough for a basic use case but insufficient for optimal tool usage in complex scenarios.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must compensate. It only partially maps parameters: mentions 'required_reviews' and 'require_code_owners' (though ambiguously calling it 'optional'), but omits 'enforce_admins', 'branch', and the meanings of defaults. Does not explain that 'branch' defaults to 'main' or that 'enforce_admins' applies to admins. This leaves significant gaps for the agent.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states 'Apply a baseline branch-protection policy', specifying the action (apply), object (branch protection), and scope (baseline). It distinguishes from the sibling tool 'get_branch_protection' which is for reading.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explicitly flags it as a WRITE OPERATION and warns it's blocked unless GITHUB_MCP_READ_ONLY=false, providing clear when-to-use and when-not-to-use guidance. However, it does not explicitly name alternatives like 'get_branch_protection' for reading, leaving inference to the agent.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.