sec_frames

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

Discloses credential-free access and returns every filer's value, but omits details on pagination, rate limits, or handling of missing data. No annotations present to compensate.

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?

Three concise sentences, front-loaded with core purpose, no redundant information. Every sentence 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?

Adequate for a simple data retrieval tool with well-documented schema, but lacks return format details and handling of large result sets given the limit parameter.

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?

All parameters have schema descriptions (100% coverage), so the description adds minimal new meaning—only contextualizing concept and period as EDGAR frames.

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?

Clearly states the tool retrieves cross-company values for one XBRL concept and period, distinguishing it from other SEC tools like sec_company_submissions or sec_financials.

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?

Implies usage for aggregate XBRL data across companies, but lacks explicit when-to-use/when-not-to-use guidance or mentions of alternative tools for single-company data.

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