Skip to main content
Glama

describe_notation

Return the self-describing Markdown document for a built-in VGraph notation. The document includes the notation's purpose, when to use it, node types, edge types, group types, detailings (which node types can be decomposed and what goes inside them), history, and references.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "notation": "<notation>"
    },
    "name": "describe_notation"
  }
}

Input Schema

NameRequiredDescriptionDefault
notationYesName of the built-in notation

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / notation / enum
      Previous value: -[
      -  "IBIS"
      -]New value: +[
      +  "IBIS",
      +  "BBS",
      +  "ImpactMapping",
      +  "ConceptMap",
      +  "CRT",
      +  "EC",
      +  "FRT",
      +  "PRT",
      +  "TRT",
      +  "ADTree",
      +  "GoalTree",
      +  "CLD",
      +  "DecisionTree",
      +  "Timeline",
      +  "C4",
      +  "Arithmetic"
      +]
  2. First observed

TDQS

A4.1/5.0
Behavior4/5

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

With no annotations, the description bears the full burden, and it does a good job disclosing the return payload: purpose, usage guidance, node/edge/group types, detailings, history, and references, plus the fact that output is Markdown. Missing only operational details like error behavior for an invalid notation or any read-only/caching guarantees.

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 action and artifact type, then a compact enumeration of what the document contains. No filler and nothing redundant.

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?

No output schema exists, so the description must explain the return value, and it enumerates the document's sections thoroughly enough that an agent knows exactly what it will receive. For a single-enum-parameter read tool, nothing needed for correct invocation is missing.

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% and the single parameter has an enum, so the schema already documents the input fully. The description adds only the adjective 'built-in VGraph', which is minor added meaning. 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?

States a specific verb and resource ('Return the ... document for a built-in VGraph notation') and names the exact artifact type (self-describing Markdown). This clearly separates it from the create_* siblings and decompose, since it is a read/retrieval operation rather than a builder.

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?

No explicit when-to-use or when-not guidance, but the context is strongly implied: an agent needing to learn what a notation contains before creating or decomposing one would call this, whereas the sibling tools build or decompose. The description lists the document contents but never routes the agent or states prerequisites.

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.