list_user_okrs

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

No annotations are provided, so the description must disclose behavioral traits. It only states the tool lists OKRs and gives usage hints, but does not mention side effects, rate limits, authorization requirements (beyond needing an open_id), or if it is idempotent. This is insufficient for a read tool.

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 two sentences, front-loading the purpose and then adding key requirements. Every sentence is necessary and concise, with no wasted words.

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?

The description covers the core purpose and filtering but does not describe the response format or pagination behavior. Since there is no output schema, the agent is left guessing what fields are returned. Still, for a listing tool with 6 params, it is minimally adequate.

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 description coverage is 100%, and the description adds value by explaining that user_id is the open_id and that period_ids can be obtained via list_okr_periods. This goes beyond the schema descriptions, providing actionable guidance.

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 lists a user's OKRs, specifies the required user identifier (open_id), and mentions filtering by period IDs. This distinguishes it from siblings like 'get_okrs' (likely for self) and 'list_okr_periods'.

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 context on where to obtain the user's open_id (get_login_status or search_contacts) and how to filter by period_ids using list_okr_periods. It does not explicitly contrast with alternatives like get_okrs, but the context is clear.

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