get_portfolio

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

No annotations provided, so description must disclose behavior. It reveals that the operation reads public data, returns specific fields, and deep=true costs API tokens. Missing details on auth requirements, rate limits, or failure scenarios, but acceptable given the tool's simplicity.

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 (4 sentences), front-loaded with purpose, and every sentence provides essential information without fluff.

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 one non-required parameter, no output schema, and no annotations, the description covers the tool's functionality well—returns, deep mode behavior, cost implications. A minor gap: no mention of pagination or limit on number of repos returned.

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?

Schema coverage is 100% (1 param, described in schema). The description adds value by explaining what deep=true does in detail (extracts stack, complexity, etc.) and when to use it, going beyond the schema's basic description.

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 ('Fetch') and resource ('public GitHub repos for the user'), and is distinct from siblings like 'get_profile' (user profile) and 'read_repo' (single repo). It is specific and unambiguous.

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?

Explicit guidance on when to use deep=true ('when you explicitly need structured analysis and the user has authorized API spend') and when to omit it ('for the free metadata+README fetch'). However, it does not compare to sibling tools like 'read_repo', which might be more appropriate for a single repo.

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