Skip to main content
Glama

Plan a JSON Patch

bpj_plan_json_patch
Read-onlyIdempotent

Validate required RFC 6902 operation fields and list target and source paths for review.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "patch": "<patch>"
    },
    "name": "bpj_plan_json_patch"
  }
}

Input Schema

NameRequiredDescriptionDefault
patchYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.7/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false and openWorldHint=false, so safety is covered structurally. The description adds that only required fields are validated and that target/source paths are surfaced, but omits the most important behavioral fact — that no patch is ever applied — and says nothing about failure reporting.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

One tight sentence with the action front-loaded and no filler; every clause carries information about what is validated and what is returned.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With one parameter, no output schema and full annotation coverage, only a modest description is required. It covers input meaning and the shape of the review output, leaving only the non-application guarantee and error reporting unstated — small but real gaps for a 'plan' tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0% for the single 'patch' parameter, and the description compensates by tying it to RFC 6902 operation fields and indicating that operation fields are checked and paths extracted. It does not mention the string-encoded array form or the 8000-character limit, but the core semantic (an RFC 6902 op array) is conveyed.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description gives a specific verb ('Validate') plus concrete outputs ('list target and source paths'), and names the RFC 6902 standard, so an agent knows exactly what the call produces. It stops short of distinguishing itself from siblings such as bpj_apply_json_merge_patch — nothing says it plans/reviews rather than applies — so it is clear but not differentiated.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The phrase 'for review' implies this is a pre-flight check before applying a patch, which is the intended usage, but it is never stated explicitly and no alternative tool is named. An agent must infer when to prefer this over an apply-style sibling.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.