get_ephys_sweeps

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

With no annotations provided, the description carries the full burden. It only says 'Get', implying a read operation, but does not disclose any behavioral traits like pagination behavior, data source freshness, or that it is read-only. No side effects or access requirements are mentioned.

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 a single sentence with no wasted words. It immediately conveys the action and resource. It is optimally concise and front-loaded.

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 tool has no output schema, so the description should ideally hint at what sweep records contain or how they relate to other data. It does not. However, for a simple retrieval tool with two parameters, it provides the essential context (specimen ID and database source), making it 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?

Both parameters are described in the schema (100% coverage). The tool description repeats the specimen ID context ('specific cell specimen') but adds no additional meaning beyond the schema. The numRows parameter is also explained in the schema. Baseline score of 3 applies.

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 retrieves electrophysiology sweep records for a specific cell specimen from the Allen Cell Types Database. It distinguishes itself from sibling tools like get_ephys_features and download_cell_ephys_data by specifying the exact resource and scope.

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?

No guidance is provided on when to use this tool versus alternatives such as get_ephys_features or download_cell_ephys_data. The description does not mention any prerequisites, context for use, or exclusion criteria.

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