Skip to main content
Glama

Compare Diagram Versions

flowzap_diff
Read-onlyIdempotent

Compare two FlowZap Code versions and return a structured diff.

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": {
      "oldCode": "<oldCode>",
      "newCode": "<newCode>"
    },
    "name": "flowzap_diff"
  }
}

Input Schema

NameRequiredDescriptionDefault
newCodeYesUpdated FlowZap Code
oldCodeYesOriginal FlowZap Code

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.4/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 closed-world scope, so the safety profile is covered structurally. The description adds only the fact that output is a "structured diff" – it does not describe the diff's granularity, formatting, or what happens if the supplied code is malformed. Useful but thin beyond 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.

Conciseness4/5

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

A single front-loaded sentence with zero filler, but the terseness comes at the cost of context rather than being optimally economical – it could carry one more clause about output or usage without bloat.

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 simple two-string read-only tool this is close to adequate, and the absence of an output schema is mitigated slightly by mentioning a structured diff. However, an agent still has no idea what the diff looks like or how to interpret it, and there is no guidance on error cases, which leaves the definition usable but incomplete.

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 100%, so the two required params (oldCode, newCode) are already fully documented as "Original FlowZap Code" and "Updated FlowZap Code". The description adds no extra semantics such as ordering, size limits, or version requirements, so the baseline 3 applies.

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?

States a specific verb+resource pair ("Compare two FlowZap Code versions") and names the return artifact ("structured diff"), which is enough to tell it apart from validation or mutation siblings like flowzap_validate and flowzap_apply_change. It stops short of explicitly naming the sibling it replaces, so 4 rather than 5.

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?

Usage is implied by the tool's nature: reach for it when you have two versions of FlowZap Code and want their differences. There is no explicit when-to-use, no mention of which sibling to pick for related tasks (e.g., flowzap_apply_change when you actually want to apply a diff), and no note on preconditions such as valid code.

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.