cja_list_segments

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

With no annotations, the description discloses key behavioral aspects: it retrieves segments the user has access to, supports pagination and expansion, and returns a dictionary. It does not explicitly declare read-only intent, but the listing nature implies no side effects.

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 well-structured with a brief opening, parameter list, return note, and example queries. It is slightly verbose due to the parenthetical clarification about segments/filters, but all content adds value.

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 7 parameters and no output schema or annotations, the description covers the tool's functionality well, including parameter details and use examples. It lacks precise output structure (e.g., exact keys), but the dictionary description is adequate for a list tool.

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 0%, but the description fully compensates by explaining each parameter: dataview_id (optional filter, default), name (partial match), tag_names (comma-delimited), include_type (with examples 'shared', 'all', 'templates'), limit (default 10, max 1000), page (0-indexed), expansion (list of fields).

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 'List all available segments/filters in CJA', using a specific verb and resource. It distinguishes segments from related siblings like cja_get_segment_details and cja_create_segment by focusing on listing all accessible segments.

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?

Example queries demonstrate typical use cases (e.g., 'List all available segments', 'Show me segments with 'mobile' in the name'). However, the description does not explicitly state when to avoid this tool or compare it to siblings like cja_get_segment_details for more detail.

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