Skip to main content
Glama
delimit-ai

delimit

Official
by delimit-ai
OverviewSchemaSourceRelated ServersScoreDiscussionsAdmin
Python
Hybrid

Delimit Diff Report

delimit_diff_report

Generate a shareable API diff report with full analysis, including diff, policy checks, semver impact, spec health, and migration guide. Ideal for API reviews, PR comments, and compliance records.

Instructions

Generate a shareable API diff report with full analysis.

When to use: when a team needs a shareable artifact (API review, PR comment, compliance record) — runs diff + policy + semver + spec health + migration guide. When NOT to use: for a CI gate verdict (use delimit_lint) or raw diff data (delimit_diff).

Sibling contrast: delimit_lint enforces; delimit_diff is raw; this is the presentable composite report.

Side effects: read-only on inputs. When output_file is provided, writes the rendered HTML/JSON to disk. The HTML has inline CSS — no external dependencies, opens in any browser.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
new_specYesProposed OpenAPI spec path.
old_specYesBaseline OpenAPI spec path.
output_fileNoOptional path to write the report to disk.
policy_fileNoOptional .delimit/policies.yml path.
output_formatNo"html" (default) or "json".html

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. Changed5 schema fields changedv4.7.9
    • changedInput schema / properties / new_spec / description
      Previous value: -"Path to the new (proposed) OpenAPI spec file."New value: +"Proposed OpenAPI spec path."
    • changedInput schema / properties / old_spec / description
      Previous value: -"Path to the old (baseline) OpenAPI spec file."New value: +"Baseline OpenAPI spec path."
    • changedInput schema / properties / output_file / description
      Previous value: -"Optional file path to write the report to disk."New value: +"Optional path to write the report to disk."
    • changedInput schema / properties / output_format / description
      Previous value: -"\"html\" for a standalone HTML report, \"json\" for structured data."New value: +"\"html\" (default) or \"json\"."
    • changedInput schema / properties / policy_file / description
      Previous value: -"Optional path to a .delimit/policies.yml file."New value: +"Optional .delimit/policies.yml path."
  2. Addedv4.5.5

TDQS

A4.7/5.0
Behavior5/5

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

Beyond the minimal annotations, it discloses that the tool is read-only on inputs but writes a rendered HTML/JSON file when output_file is provided, plus a useful detail about inline CSS/no external dependencies. This is meaningful behavioral context that the annotations do not provide.

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?

The description is well structured with labelled sections, front-loaded purpose, and every sentence adds value. The when-to-use, contrast, and side-effect notes are compact and easy to scan.

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

Completeness5/5

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

Given the output schema exists and the annotations mark safety, the description covers the remaining operational context: use cases, alternatives, side effects, and output characteristics. Nothing needed for correct selection or invocation is missing.

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 schema already documents all five parameters. The description adds report-composition context (diff, policy, semver, spec health, migration guide) but does not materially enrich parameter-level semantics beyond that baseline.

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

Purpose5/5

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

The description starts with a specific verb and resource: 'Generate a shareable API diff report with full analysis.' It then distinguishes this tool from delimit_lint and delimit_diff, so an agent can select it correctly.

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

Usage Guidelines5/5

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

Gives explicit when-to-use scenarios (API review, PR comment, compliance record), a clear when-not-to-use section with named alternatives, and a sibling contrast line. An agent knows exactly when to choose this tool instead of delimit_lint or delimit_diff.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/delimit-ai/delimit-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server