Retrieve documentation and usage examples for a specific Jaquel operator to understand its syntax and application.
Get documentation and examples for a Jaquel operator.
| Name | Required | Description | Default |
|---|---|---|---|
| operator | Yes | Jaquel operator name, e.g. '$like', '$gt', '$in', '$between' |
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Changes observed during successful MCP inspections.
v0.1.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The readOnlyHint annotation already establishes that this is a safe read operation. The description adds no additional behavioral context such as return type details, error behavior, or authentication requirements, but it also does not contradict the annotations.
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 with no filler. Every word contributes to explaining what the tool does, which is ideal for a simple one-parameter documentation tool.
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 single-parameter, read-only tool with an output schema, the description is fully sufficient. It tells the agent what the tool returns, and the input is fully defined in the schema.
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 100%, and the schema already documents the 'operator' parameter with examples. The description adds no new parameter semantics, but none are needed given the schema's completeness.
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 states a specific action ('Get documentation and examples') and a specific resource ('Jaquel operator'), so an agent knows exactly what the tool provides. The resource term also distinguishes it from siblings like query_get_pattern and query_describe.
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 implies this tool is for retrieving Jaquel operator documentation, but it does not explicitly state when to prefer it over sibling tools or mention any exclusions. Usage context is inferable rather than explicit.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.