Search the Pumpkin Plugin API and WIT codebase by string or regex to locate plugin interfaces, documentation, and implementation examples.
Searches for a string or regex pattern in the Pumpkin Plugin API and WIT codebase
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | The search term or regex pattern | |
| isRegex | No | Whether the query is a regular expression |
Changes observed during successful MCP inspections.
v1.0.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the full burden and only conveys the search scope. It omits case sensitivity, match limits or pagination, how results are returned, and whether the operation is purely read-only.
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 that states the action and scope with zero filler. Nothing could be trimmed without losing meaning.
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?
No output schema exists, so the description should ideally hint at result shape and limits, and with no annotations it should at least confirm the read-only nature. The scope statement covers the essentials but leaves meaningful gaps for an agent deciding how to interpret results.
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 both query and isRegex are already documented inline. The description's mention of "string or regex pattern" loosely reinforces isRegex but adds no syntax, format, or default information 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?
States a specific verb ("Searches") and resource (a string or regex pattern) scoped to the Pumpkin Plugin API and WIT codebase. It is clearly distinguishable from read/list siblings, though it never explicitly contrasts itself with read_api_file or list_api_files.
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?
No guidance on when to search versus reading files directly, nor any mention of prerequisites or exclusions. The agent must infer from the verb alone that this is the discovery tool and the read_* tools are for retrieval.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.