search_docs
Search the UmbHost Knowledgebase documentation. Returns the best-matching pages with snippets and URLs.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | What to search for |
Search the UmbHost Knowledgebase documentation. Returns the best-matching pages with snippets and URLs.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | What to search for |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full behavioral burden. It usefully discloses that results are ranked best matches with snippets and URLs, but it does not address read-only safety, authentication, rate limits, 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?
Two concise sentences with the core purpose and return format front-loaded. Every sentence contributes useful information with no filler.
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 one-parameter search tool with 100% schema coverage and no output schema, the description covers purpose and return values adequately. The main missing element is routing guidance relative to sibling tools.
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?
The single query parameter is fully documented in the schema as "What to search for," so the description does not need to compensate. It adds no additional syntax or formatting detail beyond the schema.
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 specific verb and resource ("Search the UmbHost Knowledgebase documentation") and states the return shape (best-matching pages with snippets and URLs). It is clear what the tool does, but it does not explicitly differentiate it from siblings like get_doc or list_docs.
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 guidance on when to use search_docs versus get_doc or list_docs. The description implies keyword-based retrieval but leaves the choice between tools to inference.
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.