pr_activity

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

With no annotations, the description carries the full burden of behavioral disclosure. It does disclose some behavior by stating the activity log includes 'approvals, comments, updates,' but it does not mention read-only status, pagination, ordering, or any permissions. This is a modest level of transparency, enough to understand basic behavior but lacking depth.

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 and front-loaded, with a single-sentence summary followed by a brief Args list. Every sentence contributes, and there is no wasted or redundant text.

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 the output schema exists, return values are covered. However, the description lacks contextual completeness in guiding tool selection among many siblings. It doesn't explain the relationship to other PR-related tools or provide enough context for an agent to decide when this is the appropriate tool. The description is adequate for a simple read operation but could be more complete.

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 0% description coverage, so the description's Args section adds necessary meaning. It clarifies that pr_id is a 'PR ID number' and that workspace/repo are 'slugs,' which is useful. However, it does not explain optionality or default behavior (e.g., empty strings for repo/workspace), leaving some gaps.

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 the tool's function with a specific verb and resource: 'Get activity log for a pull request.' It lists examples (approvals, comments, updates) which distinguishes it from sibling tools like pr_commits or list_pr_comments. This is a specific and clear purpose.

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 provides no guidance on when to use this tool versus alternatives. It does not mention any exclusions or explicitly name sibling tools for similar operations, such as pr_commits for commit history or list_pr_comments for comments. This leaves the agent to infer usage from the vague purpose.

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