Skip to main content
Glama
HakashiKatake

docorbit

by HakashiKatake
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

diff_docs

Compare documentation versions and snapshots to detect added, removed, modified, or deprecated API endpoints, parameters, pitfalls, sections via deterministic diffs ignoring formatting-only changes.

Instructions

Compare documentation snapshots and versions to detect added, removed, modified, and deprecated API endpoints, parameters, pitfalls, and content sections. Produces deterministic diffs ignoring formatting-only changes.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
toNoAlias for toVersion.
fromNoAlias for fromVersion.
formatNoResponse format: "markdown" (default, human/agent-readable documentation) or "json" (structured raw machine data).
sourceIdNoOptional documentation source ID filter.
toVersionNoTarget documentation version to compare against (e.g. "v15", "2.0").
fromVersionNoBase documentation version (e.g. "v14", "1.0").
toSnapshotIdNoTarget snapshot ID to compare.
fromSnapshotIdNoBase snapshot ID to compare.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.2.3
    • addedInput schema / properties / format
      Added value: +{
+  "description": "Response format: \"markdown\" (default, human/agent-readable documentation) or \"json\" (structured raw machine data).",
+  "enum": [
+    "markdown",
+    "json"
+  ],
+  "type": "string"
+}
  2. Changed2 schema fields changedv0.1.7
    • addedInput schema / properties / from
      Added value: +{
+  "description": "Alias for fromVersion.",
+  "type": "string"
+}
    • addedInput schema / properties / to
      Added value: +{
+  "description": "Alias for toVersion.",
+  "type": "string"
+}
  3. First observedv0.1.4

TDQS

A3.9/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and adds meaningful behavioral context: it states the diff is deterministic and ignores formatting-only changes, and it enumerates the categories of changes detected. It does not explicitly state permissions or side effects, but the comparison nature implies a read-only operation.

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?

Two sentences, front-loaded with the core purpose and followed by a key behavioral trait. Every sentence earns its place with no redundant or filler content.

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?

No output schema exists, and the description does not explain the structure of the returned diff or the default behavior when optional version/snapshot parameters are omitted (all 8 parameters are optional). While it describes what changes are detected, it leaves key operational details unstated.

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 8 parameters in detail. The description mentions snapshots and versions broadly but adds no syntax, defaults, or format details beyond what the schema provides; baseline 3 is appropriate.

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 uses a specific verb ('Compare') and resource ('documentation snapshots and versions'), and explicitly lists what it detects: added, removed, modified, and deprecated API endpoints, parameters, pitfalls, and content sections. It clearly distinguishes itself from sibling tools like get_version or search_docs, which retrieve rather than diff.

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 purpose—comparing versions/snapshots—but there is no explicit guidance on when to use this tool versus alternatives such as get_version or search_docs, nor any mention of prerequisites or when not to use it.

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