Github Submit Review

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

Annotations already tell the agent this is a non-readOnly, non-idempotent, non-destructive action, but the description adds little behavioral detail. It does not explain how submitting a review affects PR state, permissions required, or whether multiple reviews can be submitted; the only extra is the procedural pointer to the pr-review skill, which is workflow rather than behavior.

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 definition has two short sentences, is front-loaded with the primary purpose, and contains no filler or repetition. It is appropriately sized for a simple tool definition even though richer parameter content is absent.

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?

For a mutating operation with five parameters and an event enum, this is barely complete: the schema names and enum values are self-explanatory, and an output schema exists, so an agent can attempt a call. But the definition itself omits behavioral consequences and clear alternatives, relying on the referenced github_get_skill to fill the gaps.

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?

With schema description coverage at 0 percent, the description needed to compensate, but it names no parameters and explains none of them. The phrase specific pull request does not communicate the event enum semantics or the nullable body, leaving the input schema to carry the entire burden.

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 states a concrete action and target: Submits a review for a specific pull request. This clearly identifies the core operation and broadly separates it from PR-comment and listing siblings, though it does not explicitly disambiguate against very close siblings such as github_add_pr_comments or github_reply_to_review_comment.

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 second sentence, Workflow and conventions: github_get_skill('pr-review'), directs the agent to load PR-review conventions before acting, which is useful procedural guidance. However, it never states when to prefer this tool over sibling comment/review tools or when not to use it, so the usage distinction is only implied.

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