search
Search OpenPlanr docs passages. Optional section is the URL's first segment after /docs/ (for example skills or get-started), or course for course pages.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | ||
| section | No |
Search OpenPlanr docs passages. Optional section is the URL's first segment after /docs/ (for example skills or get-started), or course for course pages.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | ||
| section | No |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnly, idempotent, closed-world and non-destructive, so the safety profile is fully covered. The description adds nothing about ranking, result limits, or what a match looks like, so beyond annotations it contributes little behavioral context.
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 tight sentences, front-loaded with the action and followed by the only non-obvious parameter semantics. Nothing is wasted.
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 two-parameter read-only search with rich annotations, the essentials are present, but the description never says what the results are or how they should be used relative to fetch_page. That gap matters for an agent deciding whether search alone suffices.
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 description coverage is 0%, so the description carries the burden and does explain the non-obvious `section` parameter well, including its URL-segment origin and the special `course` value, which the regex-only schema does not convey. The required `query` param is self-evident and left implicit.
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 and resource ("Search OpenPlanr docs passages") and adds the scope of the search. It doesn't explicitly distinguish itself from the sibling fetch_page, but the verb/resource pairing makes the job clear.
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?
Usage is only implied: an agent can infer this is for locating passages when it lacks an exact page. There is no explicit when-to-use versus fetch_page, no note that results must be followed by a fetch, and no exclusions.
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.