Search Documentation
searchSearches through documentation with the given search query, returning a list of results with ID, title, and URL.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | search query |
searchSearches through documentation with the given search query, returning a list of results with ID, title, and URL.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | search query |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, destructiveHint=false, and a closed-world scope, so the safety profile is covered. The description adds the return fields (ID, title, URL), which is genuinely useful since there is no output schema, but says nothing about result limits, ranking, or pagination behavior.
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?
A single front-loaded sentence with the action first and the return shape second; no wasted words. It is tight, though it spends its one sentence partly on return values rather than on the disambiguation the agent actually lacks.
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?
For a one-parameter read-only search with annotations and a stated return shape, the definition is broadly adequate. It is still thin on where the scope boundary lies relative to the endpoint-specific siblings and on how many results come back, which matters for planning follow-up calls.
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% for the single query parameter, so the schema already carries the parameter documentation. The description only restates "with the given search query" and adds no syntax, matching, or formatting guidance, so baseline 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 gives a concrete verb and resource ("Searches through documentation") and even previews the result shape (ID, title, URL). However, it never distinguishes this tool from the sibling search-endpoints or list-endpoints, so an agent cannot tell from the text alone whether generic search also covers endpoint documentation.
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?
There is no explicit when-to-use guidance and no mention of alternatives such as search-endpoints, list-endpoints, or fetch. The agent must infer that this is the right tool for keyword lookup over docs, with no stated exclusions or conditions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.