Skip to main content
Glama
delimit-ai

delimit

Official
by delimit-ai
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Hybrid

Delimit Explain

delimit_explain
Read-onlyIdempotent

Explain API changes from OpenAPI spec diffs as readable migration notes, PR comments, changelogs, or Slack summaries using template-driven output.

Instructions

Render a human-readable explanation of API changes (7 templates).

When to use: to produce migration notes, PR comments, changelog entries, or Slack-friendly summaries from a spec diff. When NOT to use: for raw change data (use delimit_diff) or a shareable HTML report (delimit_diff_report).

Sibling contrast: delimit_diff returns structured change data; delimit_diff_report renders an HTML report; this renders a template-driven text explanation.

Side effects: read-only. Calls backends.gateway_core.run_explain.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
api_nameNoAPI/service name for context.
new_specYesPath to the proposed OpenAPI spec file. Required.
old_specYesPath to the baseline OpenAPI spec file. Required.
templateNoOne of "developer" (default), "team_lead", "product", "migration", "changelog", "pr_comment", "slack".developer
new_versionNoNew version string for context.
old_versionNoPrevious version string for context.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changedv4.7.9
    • changedInput schema / properties / new_spec / description
      Previous value: -"Path to the new OpenAPI spec file."New value: +"Path to the proposed OpenAPI spec file. Required."
    • changedInput schema / properties / new_version / description
      Previous value: -"New version string."New value: +"New version string for context."
    • changedInput schema / properties / old_spec / description
      Previous value: -"Path to the old OpenAPI spec file."New value: +"Path to the baseline OpenAPI spec file. Required."
    • changedInput schema / properties / old_version / description
      Previous value: -"Previous version string."New value: +"Previous version string for context."
    • changedInput schema / properties / template / description
      Previous value: -"Template name (default: developer)."New value: +"One of \"developer\" (default), \"team_lead\", \"product\", \"migration\", \"changelog\", \"pr_comment\", \"slack\"."
  2. Changed6 schema fields changedv4.5.5
    • addedInput schema / properties / api_name / description
      Added value: +"API/service name for context."
    • addedInput schema / properties / new_spec / description
      Added value: +"Path to the new OpenAPI spec file."
    • addedInput schema / properties / new_version / description
      Added value: +"New version string."
    • addedInput schema / properties / old_spec / description
      Added value: +"Path to the old OpenAPI spec file."
    • addedInput schema / properties / old_version / description
      Added value: +"Previous version string."
    • addedInput schema / properties / template / description
      Added value: +"Template name (default: developer)."
  3. First observedv0.1.0

TDQS

A4.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint, so the safety profile is well covered. The description adds 'Side effects: read-only' and the internal backend call 'backends.gateway_core.run_explain', which provides useful implementation transparency consistent with 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.

Conciseness5/5

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

The description is compact and well-structured, front-loading purpose before usage guidance and side effects. Every section earns its place, and the sibling contrast avoids redundant repetition while adding clarity.

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?

The tool has an output schema, so return-value explanation is unnecessary. The description covers purpose, use cases, exclusions, sibling alternatives, side effects, and an internal call reference, leaving no meaningful gaps for an agent to select and invoke it correctly.

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 100%, so the baseline is 3. The description adds value by mapping template-oriented outputs to use cases like migration notes, PR comments, changelog entries, and Slack summaries, enriching the meaning of the template parameter beyond the schema's enum-like list.

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 opens with a specific verb and object: 'Render a human-readable explanation of API changes (7 templates).' It clearly identifies the tool's deliverable and explicitly contrasts it with delimit_diff and delimit_diff_report, making it easy to distinguish from the closest siblings.

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?

The description provides an explicit 'When to use' section listing concrete use cases, a 'When NOT to use' section naming sibling alternatives, and a 'Sibling contrast' section. This gives an agent complete routing guidance for when to select this tool over alternatives.

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

Deploy Server

Other Tools