Skip to main content
Glama

graphviz_publish_markdown

Idempotent

Render a bounded diagram hierarchy from DOT source and update its root Markdown reference automatically, keeping documentation in sync.

Instructions

Render a bounded diagram hierarchy and update its root Markdown reference.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
anchorNo
formatNosvg
alt_textNoGraphViz diagram
dot_pathYes
output_pathNo
project_dirYes
markdown_pathYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.1

TDQS

C2.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, idempotentHint=true, and destructiveHint=false. The description adds that it updates a Markdown reference, which is consistent with the annotations but doesn't disclose the exact side effects or whether existing content is overwritten.

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 a single sentence with no redundant words. It is concise and to the point, though its brevity sacrifices clarity.

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

Completeness2/5

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

With 7 parameters, no parameter descriptions, and several sibling tools, the one-sentence description is insufficient. It does not explain the overall workflow, error conditions, or relationship to the output schema, leaving the agent to guess too much.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters1/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0% and the description provides no clarification for any of the 7 parameters. It doesn't explain that dot_path is the source diagram, markdown_path is the file to update, or how anchor/format/alt_text/output_path are used.

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

Purpose3/5

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

The description uses a clear verb ('Render' and 'update') but the phrase 'bounded diagram hierarchy' is jargon and not self-explanatory. It doesn't clearly distinguish from sibling tools like graphviz_render or graphviz_sync.

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

Usage Guidelines1/5

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

No guidance is provided on when to use this tool versus alternatives. It doesn't mention that graphviz_render should be used when no Markdown update is needed, or that graphviz_sync handles bulk synchronization.

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