search_docs
Search RudderStack documentation using semantic search
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | ||
| num_results | No | Number of results. Default: 5, max: 20 |
Search RudderStack documentation using semantic search
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | ||
| num_results | No | Number of results. Default: 5, max: 20 |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, openWorldHint and destructiveHint=false, so the safety profile is covered. The description adds only that results come from semantic (not keyword) search, and says nothing about ranking, result caps, or return shape. That is modest added value beyond the structured fields.
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?
One front-loaded sentence with no filler, and the key differentiator (semantic search) is stated immediately. It is arguably too terse rather than padded, so it is not penalized for verbosity.
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 simple two-parameter read tool with no output schema, the essential facts are present, but the description never indicates what a result contains (doc snippets, URLs, scores) or how the semantic search behaves on no-match queries. A short note on return content and on ask_docs would make it complete.
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 50%: num_results is documented in the schema with a default and max, but query has no description. The description adds nothing about query phrasing or the effect of num_results. Baseline 3 applies since the schema carries most of the load for a two-parameter tool.
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?
States a specific verb (Search) and resource (RudderStack documentation) and adds the mechanism (semantic search), which distinguishes it from a generic lookup. However, it does not differentiate itself from the sibling ask_docs, which plausibly covers the same documentation corpus from a question-answering angle.
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 guidance on when to use this versus ask_docs, or when semantic search beats a direct docs lookup. The agent must infer the choice from tool names alone, and no exclusions or prerequisites are given.
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.