get_ip_core

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

No annotations are provided, so the description carries full burden. It mentions fetching files but does not disclose behavioral traits such as whether this requires authentication, rate limits, what happens if the core doesn't exist, or the format of the returned data. This leaves significant gaps for a tool that retrieves resources.

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, efficient sentence that front-loads the key action and resource. Every word earns its place, with no wasted text, making it highly concise and well-structured.

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's complexity (fetching files for IP cores), no annotations, and no output schema, the description is minimally adequate but incomplete. It states what is fetched but lacks details on behavior, error handling, or output format, which are important for such an operation.

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 100%, with the parameter 'name' documented as 'Core name, e.g. 'uart_tx' or 'fifo''. The description adds no additional meaning beyond this, as it only references 'named IP core' without extra details. Baseline 3 is appropriate when schema handles parameter documentation.

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 specific action ('fetch') and resource ('full manifest and HDL source files for a named IP core'), distinguishing it from siblings like 'list_ip_cores' (which likely lists names) or 'import_github_core' (which imports from external sources). It precisely defines what the tool retrieves.

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?

The description implies usage when you need source files for a specific IP core, but it does not explicitly state when to use this versus alternatives like 'import_github_core' or 'search_github_cores'. It provides basic context but lacks explicit guidance on exclusions or comparisons.

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