Skip to main content
Glama

busabase

by com.busabase
OverviewDiscussionsAdmin

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, call playbooks_search first: 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 seed records through one real review. 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.

Input Schema

TableJSON 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.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, lowering the burden. The description adds real behavioral context: the guide carries workspace conventions, airapp has a runtime contract, and ignoring it causes the app to fail before rendering. It does not describe the output format, but that is less critical for a read-only guide 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?

The description is front-loaded with the primary purpose and when-to-use instruction, followed by a scannable bullet list. It is longer than minimal, but the detail about each guide topic and the required airapp reading earns its place.

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 low-complexity read-only tool, the description covers prerequisites, alternatives, required readings, and failure consequences. It does not explicitly state the return shape, but 'read' makes it obvious that the guide content is returned, and there is no output schema to add detail.

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 meaningful semantics for the main topic parameter by explaining what each guide contains (workspace workflow, airapp runtime contract, setup, app creation, installed apps) and the skill:<slug> form. The playbook and targetSpaceId parameters are already well described in the schema.

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 verb and resource: 'Read a Busabase guide.' It also distinguishes itself from the closest sibling by saying 'For a user's task, call playbooks_search first' and explaining that these guides cover how Busabase itself works. An agent can tell exactly what this tool is for.

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?

Usage guidance is explicit and actionable: 'Call this BEFORE doing unfamiliar work' and 'call playbooks_search first' for user tasks. It also gives a hard precondition: reading airapp is REQUIRED before writing any AirApp file, with concrete failure consequences.

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

All busabase toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources