Skip to main content
Glama

Comment on pull request as formal review at exact head

gh_comment_pr_review

Submit a formal GitHub COMMENTED PR review tied to a specific head SHA, capturing an external or Central disposition without marking the PR as APPROVED.

Instructions

Additive write: submit exactly one formal GitHub COMMENTED review through the ordinary authenticated GitHub principal for the supplied exact PR head. This is the explicit same-author fallback for recording an external or Central disposition; COMMENTED is never reported as GitHub APPROVED. The write is attempted once and immutable review-ID readback verifies actor, state, head, and body. It cannot select reviewer credentials, approve, merge, or retry an ambiguous mutation automatically.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyYesNon-empty Markdown review body. This may record an external/Central positive disposition, but GitHub state remains COMMENTED, never APPROVED.
repoYesGitHub repository name without the owner prefix.
ownerYesGitHub repository owner or organization login.
numberYesPull request number on which to record a formal comment review.
expected_head_shaYesExact pull-request head SHA to which the COMMENTED review is bound.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlYes
bodyYes
stateYes
actionNocomment
authorNo
numberYes
messageYes
warningNo
review_idYes
commit_shaYes
request_idNo
submitted_atNo
write_completedYes
readback_completedYes
precondition_checkedYes
state_matches_requestedYes
Behavior5/5

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

Beyond the annotations (readOnlyHint=false, destructiveHint=false, idempotentHint=false), the description adds critical behavioral details: 'Additive write' confirms non-destructiveness, 'attempted once' clarifies no internal retry, and 'immutable review-ID readback verifies actor, state, head, and body' discloses the verification mechanism. It also states limitations such as inability to approve or merge. This provides substantial transparency beyond the minimal annotation signals.

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

Conciseness5/5

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

The description is three sentences, front-loaded with the core action. Every sentence adds value: the first defines what it does, the second specifies the use case and state limitation, the third details behavioral guarantees and exclusions. No redundant phrasing or filler.

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

Completeness5/5

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

Given the tool's moderate complexity (write operation with verification and constraints) and the presence of an output schema, the description covers all essential aspects: the operation, the one-time attempt, verification, and explicit non-capabilities. It is complete enough for an agent to select and invoke correctly without needing additional context.

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

Parameters3/5

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

Schema description coverage is 100%, so parameters are already well-documented. The description reinforces the binding to 'exact PR head' and mentions that body is verified in readback, but adds no new parameter-level meaning beyond what the schema already provides. Baseline 3 is appropriate when the schema carries full semantic weight.

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

Purpose5/5

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

The description clearly states the action: 'submit exactly one formal GitHub COMMENTED review' for the 'supplied exact PR head'. It distinguishes itself from siblings by explicitly noting it 'cannot approve' and that 'COMMENTED is never reported as GitHub APPROVED', which differentiates it from gh_approve_pr and gh_request_pr_changes.

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

Usage Guidelines4/5

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

The description provides a clear use case: 'explicit same-author fallback for recording an external or Central disposition'. It also states exclusions: 'cannot select reviewer credentials, approve, merge, or retry an ambiguous mutation automatically', which implies when not to use. However, it does not explicitly name alternative tools, relying on sibling context for such inferences.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/fvanevski/gh_mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server