Skip to main content
Glama

validate_diagram_tool

Read-only

Validates Ilograph YAML syntax and structure. Returns detailed results with errors, warnings, and suggestions for corrections.

Instructions

    Validates Ilograph YAML syntax and structure.

    This tool performs comprehensive validation of Ilograph diagrams:
    1. First validates YAML syntax for structural correctness
    2. Then validates Ilograph-specific schema requirements
    3. Provides detailed error messages, warnings, and suggestions
    4. Can optionally use official Ilograph specification for context

    Args:
        content: The Ilograph diagram content as a string

    Returns:
        dict: Validation result with success/failure, errors, warnings, and suggestions
             Format: {
                 "success": bool,
                 "yaml_valid": bool,
                 "schema_valid": bool,
                 "summary": {"total_errors": int, "total_warnings": int, "total_info": int},
                 "errors": [{"level": str, "message": str, "line": int, "suggestion": str}, ...],
                 "warnings": [...],
                 "info": [...],
                 "assessment": str
             }
    

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
contentYes
Behavior4/5

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

Annotations include readOnlyHint=true, and the description confirms nondestructive validation. It goes beyond annotations by detailing the validation steps (YAML syntax, Ilograph schema), error types, and return format. No contradictions present.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

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

The description is well-structured with numbered steps and a clear return format outline. While it is somewhat verbose, every sentence adds value, and the key information is front-loaded.

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

Completeness4/5

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

Despite a minimal schema (one string parameter, no output schema), the description thoroughly explains the validation process, output structure, and error details. It is complete enough for an agent to use the tool effectively.

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?

The schema has 0% description coverage for the sole parameter 'content', but the description's Args section provides a meaningful explanation ('The Ilograph diagram content as a string'), adding value beyond the raw schema.

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 clearly states it validates Ilograph YAML syntax and structure, specifying the verb 'validates' and the resource 'Ilograph diagrams'. It distinguishes itself from siblings like check_documentation_health and check_spec_health by focusing specifically on diagram validation.

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?

The description implies when to use the tool (for validating Ilograph diagrams) but does not explicitly state when not to use it or mention alternatives among siblings. The context of use is clear, but exclusion criteria are missing.

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/QuincyMillerDev/ilograph-mcp-server'

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