gh_create_comment

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

Annotations already signal readOnlyHint=false and destructiveHint=true, so the mutation is known. The description adds no extra behavioral context such as authentication requirements, error conditions, or whether locked issues can accept comments. It merely restates the action.

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 a single, efficient sentence that front-loads the core action with no unnecessary words. It is perfectly sized for the tool's simplicity.

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?

Despite having 4 required params and no param descriptions, the tool is simple and an output schema exists. The description covers the essential function but omits potential error scenarios, prerequisites, or warning about the destructive annotation. It is minimally adequate but with clear 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?

The schema has 4 parameters with 0% description coverage. The description provides one crucial clarification: 'issue or pull request' means issue_number can refer to either an issue or a PR number. However, it fails to explain other parameter specifics like body format or constraints on owner/repo.

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 uses a specific verb 'Post' and resource 'a comment on an issue or pull request', clearly distinguishing it from sibling tools like gh_create_issue or gh_edit_issue. It unambiguously states the tool's function.

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 implies usage—posting comments on issues or PRs—but provides no explicit guidance on when to use this tool instead of alternatives like editing an issue or creating a new one. No alternatives or exclusions are mentioned.

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