xbrl_export_json

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

Annotations already declare readOnlyHint=true, destructiveHint=false, idempotentHint=true. Description adds that it returns a JSON array of serialized facts but does not elaborate on aspects like performance impact, concurrency, or error handling. The description is consistent with annotations.

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?

Description is 4 lines, front-loading the main purpose. No wasted words, but the Args/Returns structure could be more compact. Still efficient and clear.

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 has an output schema (though not shown), the description specifies the return type as 'str: JSON array of serialized facts', which is sufficient. The tool is straightforward and the description covers its role and output format adequately.

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 tool's description summarizes the params argument as 'Filing ID, filters, and limit', which is vague. However, the input schema provides detailed descriptions for each nested property (filing_id, include_dimensions, numeric_only, limit). Since schema coverage is effectively 100% via schema descriptions, the description adds minimal value, scoring baseline 3.

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?

Description states 'Export all facts from a filing as structured JSON', which is a specific verb-resource pair and clearly distinguishes from sibling tools like xbrl_export_csv or xbrl_export_concepts by specifying the output format.

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?

Description mentions 'suitable for data pipelines, database import, or further processing', giving context but does not explicitly contrast with alternatives (e.g., xbrl_export_csv) or state when not to use. No exclusion criteria provided.

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