Skip to main content
Glama

Diagram Sync

diagram_sync

Re-fetch mapped GitHub paths and append a version if they changed.

No-op when commit + content hash match. mode=authored is refused unless force=true (then the new version is mode=generated). No webhook or periodic worker — call this when you want a refresh.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
refNoOverride source.ref (defaults to the document's stored ref)
agentNoOverride agent identity
forceNoOverwrite an authored diagram. Generated diagrams sync without this; authored mode is never overwritten unless force=true
file_idYesExisting diagram shared-file UUID

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

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

  1. Added

TDQS

A4.5/5.0
Behavior5/5

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

With no annotations provided, the description carries the full burden, and it delivers: it discloses the no-op condition, the authored-mode refusal without force=true, the resulting generated mode when forced, and the absence of background automation. This is detailed behavioral context beyond what a bare schema provides.

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?

Four short sentences cover purpose, no-op behavior, force semantics, and when to call. Every sentence earns its place, and the main action is front-loaded. There is no filler or repetition.

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?

For a sync/mutation tool with no annotations and an output schema present, the description is complete: it explains the refresh trigger, no-op condition, force behavior, and lack of background scheduling. The output schema covers return values, and the input schema covers parameters.

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 four parameters thoroughly. The description reinforces the force behavior but does not materially add new parameter semantics beyond the schema's existing explanations.

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—'Re-fetch mapped GitHub paths and append a version if they changed'—and clearly identifies the resource being synced. This distinguishes it from the sibling diagram_generate by framing diagram_sync as a refresh/update operation rather than creation.

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

Usage Guidelines4/5

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

The description gives explicit guidance on when to call it: 'No webhook or periodic worker — call this when you want a refresh.' It also tells the agent the tool is a no-op when nothing changed. It does not explicitly name an alternative tool for comparison, but the call-to-action is clear.

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.