search_issues
Search for known issues, bugs, workarounds, and solutions across connected sources.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | Issue or error to search for |
Search for known issues, bugs, workarounds, and solutions across connected sources.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | Issue or error to search for |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the transparency burden. It adds the context that searches span 'connected sources', but does not disclose return format, pagination, or whether it is strictly read-only (though inferred from 'Search'). This is adequate but not rich.
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, front-loaded sentence that directly states the tool's function. Every word adds value with no redundancy or 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 no output schema, the description is mostly complete: it explains what it searches and why. It stops short of explicitly stating what is returned, but the purpose is clear enough for an agent to invoke correctly.
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, with a description that already clarifies it accepts an issue or error. The tool description adds context about the search scope (known issues, bugs, workarounds) but does not introduce new parameter semantics.
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 uses a specific verb 'Search' and clearly identifies the resource as 'known issues, bugs, workarounds, and solutions across connected sources'. This distinguishes it from sibling tools like search_docs and query_source by focusing on problem/solution content.
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 provides clear context: use this tool when you need to find known issues, bugs, or workarounds. It does not explicitly name alternative tools, but the domain is specific enough to imply appropriate use cases.
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.
Several tools overlap in purpose: ask_question and search_docs both return relevant passages across connected sources, and search_issues partially duplicates that for known bugs. The more specialized tools are distinct, but an agent could easily pick search_docs instead of ask_question and still get similar results.
All 8 tool names follow a consistent lower_snake_case verb_noun pattern with descriptive verbs like ask, extract, get, query, search, and summarize. There is no mixing of naming conventions, abbreviated verbs, or ambiguity in the naming style.
8 tools is well within the ideal 3-15 range for a documentation-focused MCP server. Each tool covers a plausible distinct workflow: asking, searching, summarizing, extracting schemas, code examples, quickstarts, and known issues, so none feels unnecessary.
The tool surface covers the core read-oriented documentation workflow well: search, ask, summarize, targeted source queries, schema extraction, code examples, quickstarts, and issue lookup. Minor gaps exist such as no way to list connected sources or retrieve a full raw page, but agents can work around these using query_source and search_docs.