portfolio_status

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It mentions checking 'status' but doesn't specify whether this is a read-only operation, if it requires authentication, potential rate limits, or what happens if the repository doesn't exist. For a tool interacting with external services like GitHub, this lack of detail is a significant gap.

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, well-structured sentence that efficiently lists the key aspects checked (existence, elements count, sync status, configuration details). It's front-loaded with the main purpose and avoids unnecessary words, though it could be slightly more concise by integrating the parameter hint.

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 tool's moderate complexity (checking multiple status aspects of a GitHub repository), no annotations, no output schema, and 100% schema coverage, the description is minimally adequate. It outlines what's checked but lacks details on behavioral traits, error handling, or output format, leaving gaps for an AI agent to infer correctly.

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 input schema has 100% description coverage, with the parameter 'username' clearly documented in the schema. The description doesn't add any semantic details about parameters beyond what the schema provides, so it meets the baseline of 3 for high schema coverage without compensating value.

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 verb 'check' and the resource 'GitHub portfolio repository', specifying what information is retrieved (existence, elements count, sync status, configuration details). However, it doesn't explicitly differentiate from sibling tools like 'portfolio_config' or 'sync_portfolio', which might have overlapping concerns with configuration and sync status.

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. With siblings like 'portfolio_config' (likely for configuration) and 'sync_portfolio' (likely for syncing), there's no indication of when this status check is preferred or what prerequisites might exist (e.g., after initialization).

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