List Help Center Articles

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

Discloses that it returns metadata only (no body) and includes a critical note that include_translations must be re-sent on each paginated request. This adds value beyond the readOnlyHint and destructiveHint annotations. However, it omits mention of the default sort order and pagination behavior details.

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 extremely concise—two sentences plus a note—and front-loaded with the most critical information (metadata only, alternative tool). Every sentence adds value without redundancy.

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 no output schema and the tool's paginated nature, the description explains metadata scope and the include_translations caveat well. However, it lacks details on pagination parameters (cursor, page_size, sort_order) and the response structure, which are essential for executing the tool 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?

With 71% schema coverage, the description adds context for section_id and locale (optional filters), sort_by (lists some valid values but misses 'position'), and include_translations (explains extra API call and pagination caveat). However, it does not address cursor, page_size, or sort_order, which are important for proper use.

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 it lists article metadata only, explicitly distinguishes from get_article for full content, and the verb 'List' matches the tool's function. This differentiates it from sibling tools like get_article and list_article_translations.

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?

Directs users to use get_article for full content, providing clear when-to-use guidance. Also explains optional filtering by section ID and locale. However, it does not explicitly mention when not to use this tool or how it compares to other list tools like list_article_attachments.

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