pathrule_read_rule
Read one rule by id, with its full text. Read-only.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| path | No | / | |
| workspace_id | No | Optional; defaults to the OAuth grant workspace. Cannot change its binding. |
Read one rule by id, with its full text. Read-only.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| path | No | / | |
| workspace_id | No | Optional; defaults to the OAuth grant workspace. Cannot change its binding. |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, destructiveHint=false, idempotentHint=true and openWorldHint=false, so 'Read-only' is pure repetition and adds nothing. The phrase 'with its full text' is genuinely additive since there is no output schema, but nothing is said about not-found behavior, error modes, or the workspace-binding constraint beyond what the schema already carries.
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 short, front-loaded sentences with no wasted words; the primary action leads and the read-only note trails. It is efficient, though the extreme brevity contributes to the missing parameter and usage detail.
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?
With no output schema, the description does useful work by noting the full rule text is returned. However, the unexplained `path` parameter and absent id-vs-path semantics leave meaningful gaps for a three-parameter tool with a large sibling family.
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 only 33%: the `id` and `path` parameters carry no descriptions at all. The description says the lookup is 'by id' but never explains the `path` parameter (default '/', max 2048) or how path and id interact, so it fails to compensate for the coverage gap.
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 ('Read one rule by id') and hints at scope ('with its full text'), which cleanly separates it from siblings like pathrule_list_rules and pathrule_write_rule. It does not name the sibling it displaces, so it falls short of a 5.
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 gives no explicit when-to-use guidance and never names an alternative. It implicitly assumes the caller already has an id, but says nothing about when to use pathrule_list_rules to discover ids instead, or when pathrule_history_rule would be more appropriate.
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.