Skip to main content
Glama

Compare JSON field differences

bpj_compare_json
Read-onlyIdempotent

Report added, removed and changed paths. Object member order is ignored and arrays are compared by position.

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": {
      "before": "<before>",
      "after": "<after>"
    },
    "name": "bpj_compare_json"
  }
}

Input Schema

NameRequiredDescriptionDefault
afterYes
beforeYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnly, idempotent, non-destructive and closed-world, so the safety profile is covered. The description adds genuine behavioral context the annotations cannot: object member order is ignored and arrays are compared positionally, which materially affects results. It stops short of describing the return shape (there is no output schema) or how duplicate/type-changed values appear in the report.

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

Conciseness4/5

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

Two short sentences, front-loaded with the output content and followed by the comparison rules; nothing is padded. It is arguably too terse rather than too long, but no sentence is wasted.

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

Completeness3/5

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

For a two-parameter, read-only diff tool the comparison semantics are the essential piece and they are present. However, with no output schema and no parameter documentation, the definition leaves open what a 'path' looks like, how changed values are reported, and which document 'added' is relative to.

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

Parameters3/5

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

Schema description coverage is 0%, so the description should compensate but does not name or explain 'before' and 'after', nor state that both are JSON strings capped at 8000 characters. It only implicitly establishes directionality through 'added/removed', leaving the agent to rely on the parameter titles ('Previous JSON', 'Updated JSON').

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 names the specific result units ('added, removed and changed paths'), which tells an agent this is a structural JSON diff rather than a text diff. It does not explicitly say it compares the two supplied documents, and it does not distinguish itself from nearby siblings like bpj_compare_line_sets or bpj_compare_semver.

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

Usage Guidelines2/5

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

There is no when-to-use guidance, no prerequisites, and no mention of alternatives such as a line-based or semver comparison. The agent must infer from the tool name and path behavior that this is the right choice for JSON-vs-JSON comparison.

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.