Skip to main content
Glama

get_builder_guide

Read-onlyIdempotent

Return full markdown for Ballet authoring guides (topics such as overview, playbook, sdk, agent, tool, skill, connector, report). Use when building or editing the matching artifact so step shapes and SDK contracts match Ballet. Guide ids come from list_builder_guides.

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": {
      "topics": "<topics>"
    },
    "name": "get_builder_guide"
  }
}

Input Schema

NameRequiredDescriptionDefault
topicsYesGuide ids from list_builder_guides, e.g. ["playbook", "sdk"]

Schema Changelog

Changes observed during successful MCP inspections.

No schema history has been recorded yet.

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint and idempotentHint, so safety is covered. Beyond that, the description discloses the return format (full markdown, not structured JSON) and the prerequisite call chain through list_builder_guides, which is the kind of workflow detail annotations cannot convey.

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?

Three sentences, front-loaded with the return format, then the use case, then the id dependency. No filler and no repetition of the tool title.

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?

With a single fully documented parameter, no output schema, and read-only annotations, everything an agent needs is present: what is returned (markdown), when to call it, and where ids come from. Nothing material is missing for this level of tool complexity.

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 coverage is 100% and the schema already says 'Guide ids from list_builder_guides, e.g. ["playbook", "sdk"]'. The description restates that provenance and adds an illustrative topic list, but it is hedged with 'such as' and adds little authoritative value over the schema. Baseline 3 applies when the schema carries the parameter documentation.

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 full markdown for Ballet authoring guides') and enumerates the topic space (overview, playbook, sdk, agent, tool, skill, connector, report). It also implicitly separates itself from artifact getters like get_playbook or get_agent by framing the resource as authoring documentation rather than a stored object.

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?

Gives a clear trigger: 'Use when building or editing the matching artifact so step shapes and SDK contracts match Ballet,' which tells the agent the moment this tool pays off. It also routes discovery correctly by pointing to list_builder_guides as the id source, though it names no explicit when-not condition.

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.

Resources