Skip to main content
Glama

Read a Busabase guide

busabase_guide
Read-only

Read a Busabase guide. Call this BEFORE doing unfamiliar work — it carries the conventions this workspace expects, which no tool schema can express on its own. For a user's task, read space_instructions_get first, then call playbooks_search: it finds how THIS space's owners want the job done. These guides explain how Busabase itself works.

  • workspace — The change-request workflow: everyday tools, proposing structure, field types, starter blueprints, the revision loop, errors, and the untrusted-content rules.

  • airapp — REQUIRED before writing any AirApp file. The runtime contract (npm run dev, no bundler, no native binaries), a complete working example, reading workspace data, and the failure-log table.

  • setup — Guided first-run setup for a new workspace: pick a space, choose a blueprint, build the structure, and confirm the seeded records from the write response. Needs no terminal.

  • create-app — Guided AirApp creation, from the idea through one reviewable change request. Needs no terminal.

  • apps — the manuals for apps installed in THIS workspace

Reading airapp is REQUIRED before you write any AirApp file: an app that ignores its runtime contract does not start, and the two mistakes an agent makes by default (no dev script, a Vite/bundler scaffold) both produce an app that fails before rendering anything.

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": {
      "topic": "<topic>"
    },
    "name": "busabase_guide"
  }
}

Input Schema

NameRequiredDescriptionDefault
topicYesWhich guide to read: workspace, airapp, setup, create-app, apps, or `skill:<slug>` for one installed app's own manual.
playbookNoOptional. The playbook you are following, as `kind:nodeId[:key]` from playbooks_search (e.g. `prompt:nod_123:log-visit`). Recorded on the change request so the person can see which playbook produced it.
targetSpaceIdNoBusabase space id. Call auth_verify first and ask the user which space to use when more than one is returned.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / playbook
      Added value: +{
      +  "description": "Optional. The playbook you are following, as `kind:nodeId[:key]` from playbooks_search (e.g. `prompt:nod_123:log-visit`). Recorded on the change request so the person can see which playbook produced it.",
      +  "type": "string"
      +}
  2. First observed

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already establish read-only, non-destructive, and non-open-world behavior. The description adds context annotations cannot: these guides carry workspace conventions no schema expresses, and ignoring the AirApp runtime contract causes apps to fail before rendering. It does not describe return format or pagination, but that is minor for a guide-reading tool.

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?

Purpose and usage are front-loaded, and the bulleted topic list is easy to scan. There is some redundancy: the `airapp` requirement is stated in its bullet and repeated in the closing paragraph, though the repetition reinforces a critical constraint.

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 no output schema, the description still provides enough context to invoke correctly: what each guide contains, when to read them relative to sibling tools, and the consequence of skipping the required `airapp` guide.

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?

Schema coverage is 100%, so the baseline is 3. The description adds substantive meaning for the `topic` enum by summarizing what each guide covers and emphasizing the `airapp` requirement; it does not elaborate the other two parameters beyond the schema, which is acceptable.

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: 'Read a Busabase guide.' It explains what the guides carry and distinguishes this tool from `space_instructions_get` and `playbooks_search` by role: these guides explain how Busabase itself works.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives explicit usage ordering: read `space_instructions_get` first, then `playbooks_search` for space-specific instructions; call this before unfamiliar work; and read `airapp` before writing any AirApp file. Alternatives and conditions are named directly.

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.