Skip to main content
Glama
Sign In
it-architecture

it-architecture

by slajzad
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

get_authoring_guide

Retrieve the complete notation for describing IT architecture, including DSL, JSON, styles, group kinds, and a worked example.

Instructions

Read this first. Returns the complete notation for describing an IT architecture (compact DSL + equivalent JSON), the available styles, group kinds and a worked example. No arguments.

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_authoring_guide"
  }
}

Input Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A4.3/5.0
Behavior3/5

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

No annotations are provided, so the description carries full burden. It describes the return value (notation, styles, group kinds, example) but does not disclose any side effects, rate limits, or other behavioral traits beyond being a read-only documentation tool.

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 extremely concise with a single sentence plus the 'No arguments' note. It front-loads 'Read this first' to establish priority. Every part is necessary and adds value.

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?

Given zero parameters, no output schema, and a clear purpose as an introductory guide, the description fully equips an agent to understand and invoke the tool correctly. The sibling list reinforces its role as a starting point.

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 has zero parameters, and the description explicitly confirms 'No arguments'. With 100% schema coverage and no parameters to document, the description adds sufficient clarity.

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 the tool returns 'the complete notation for describing an IT architecture', along with styles, group kinds, and a worked example. This distinguishes it from sibling tools like list_styles or list_node_types which likely return subsets.

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 tool is explicitly labeled 'Read this first', indicating it should be used before other tools. It also states 'No arguments' for simplicity. However, it does not explicitly exclude alternatives or provide when-not-to-use guidance.

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

Deploy Server

Other Tools