Search Ionic Framework documentation

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

Annotations already mark this readOnlyHint=true and destructiveHint=false, and the description adds meaningful behavioral context beyond that: it returns best-matching page sections with specific fields, attaches results as structured content, and warns that guessing component properties or CSS variables produces silently broken markup. It also clarifies that the tool does not read whole pages, setting correct expectations for the result granularity.

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 dense but every clause earns its place: purpose, scope, return shape, structured-content note, and routing to alternatives are all included. The first sentence immediately states the verb and resource, and the exclusions are batched at the end. No filler or repetition of the schema is present.

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 search behavior, rich schema, output schema, and sibling tools, the description covers everything an agent needs: what it searches, what it returns, how results should be used, and when to select a different MCP server or sibling tool. No critical operational or contextual gap remains.

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 coverage is 100%, so the baseline is 3. The description adds value by explaining the query behavior ('by keyword', 'best matching page sections') and explicitly directing agents to use returned urls with get_doc_page. It also reinforces that plain keywords work best and the tool returns structured content, which helps an agent form better queries beyond what the schema alone states.

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 states a specific action ('Search the official Ionic Framework documentation from ionicframework.com by keyword') and enumerates the exact topics it covers, from UI components to migrations. It also clearly distinguishes itself from get_doc_page by specifying that search_docs returns page sections rather than whole pages. This is a precise, resource-specific purpose statement.

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 explicitly says to use this tool first for any Ionic Framework question, and gives concrete exclusion cases: use get_doc_page for reading a full page, the Capacitor MCP server for Capacitor/native concerns, and the Capawesome MCP server for Capawesome Cloud services. This is model guidance with named alternatives and clear routing conditions.

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