Skip to main content
Glama

github_comment

Comment on an issue or pull request in this run's repository.

Requires the org's agent-writes switch.

Input Schema

NameRequiredDescriptionDefault
bodyYesComment body
githubNoowner/repo. Omit to use the run's bound github=
numberYesIssue or pull request number

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4/5.0
Behavior3/5

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

No annotations are provided, so the description carries the disclosure burden. It usefully states the agent-writes prerequisite, but does not describe side effects, failure modes, rate limits, or whether comments are editable/deletable; return details are partly handled by the output schema.

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?

Two short sentences, front-loaded with the action and followed by the key prerequisite. There is no redundant or filler text.

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

Completeness4/5

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

For a simple comment-creation tool with full parameter documentation and an output schema, the description provides adequate scope and the important permission prerequisite. It could be stronger by stating how it relates to sibling commenting tools, but nothing critical is missing.

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 the schema already documents all three parameters, including that github can be omitted to use the run-bound repository. The description reinforces the run-repository default but adds no additional parameter semantics.

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 states a specific verb and resource: commenting on an issue or pull request in the run's repository. This is precise enough that an agent can distinguish it from issue/PR reading or work-item commenting tools.

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?

It gives a clear usage context and a prerequisite: the org's agent-writes switch must be enabled, and the action targets the run's repository. It does not explicitly name alternatives such as work_comment_add or explain when not to use this tool.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.