Skip to main content
Glama

get_dbml_syntax_guide

Read-only

Read the exact DBML syntax SchemaSketch accepts before writing or editing diagrams, including a full example, to avoid validation errors.

Instructions

Read this before writing or editing any DBML — the exact syntax SchemaSketch accepts, with a full example.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_dbml_syntax_guide"
  }
}

Input Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.4

TDQS

A3.9/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so safety and locality are covered structurally. The description adds genuine content expectation — the guide contains the exact accepted syntax plus a full example — but says nothing about size, whether it should be fetched once and cached, or how it relates to other DBML tools. This is useful but not rich behavioral context beyond 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?

A single sentence with the trigger ('read this before writing or editing any DBML') front-loaded and the payload (exact syntax, full example) following. Every clause earns its place and nothing is padded.

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?

For a zero-parameter, read-only reference tool with no output schema, the description conveys both when to read it and what it contains (accepted syntax plus a full example), which is enough for an agent to call it correctly. A brief note on size or that it only needs reading once would make it complete.

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 tool takes zero parameters, so the schema baseline of 4 applies; there is no parameter meaning for the description to compensate for.

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

Purpose4/5

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

The description states the resource concretely: 'the exact syntax SchemaSketch accepts, with a full example,' which tells an agent this returns a DBML syntax reference including a worked example. It implicitly separates itself from siblings like validate_dbml (which checks DBML) by framing itself as something to read beforehand, though it never names that contrast explicitly.

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?

'Read this before writing or editing any DBML' is an explicit, actionable trigger that tells the agent exactly when to call it. There is no stated when-not condition and no named alternative (e.g., validate_dbml for checking existing DBML), so it stops short of full routing guidance.

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