Skip to main content
Glama

Read the guides

get_guide
Read-onlyIdempotent

Sections of the public guides: building with Bitbybit (what runs in the browser, on a server, on a lightweight backend, and what needs CAD Cloud), writing geometry with the kernels (which kernel to use, the order to build a part in, choosing edges, checking and exporting shapes), writing design documents (parametric models as JSON: parameters, sketches, features, references, parts and assemblies), and writing IFC building models (storeys, walls and their joins, doors, windows, slabs, roofs, rooms, properties and quantities). Without a topic it lists the sections. Read "integrate" before recommending where geometry should run: the npm packages are the default, and CAD Cloud is for algorithms that exist only there or compute the caller cannot provide. Read "geometry" before writing geometry code, "design" before writing a design document, and "ifc" before writing an IFC model.

Input Schema

NameRequiredDescriptionDefault
topicNoA section id or a short name such as integrate, browser, backend, server-side, pro, start, geometry, part-order, geometry-mistakes, design, references, assembly, ifc, ifc-order, ifc-mistakes; omit to list the sections

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / topic / description
      Previous value: -"A section id or a short name such as integrate, browser, backend, server-side, pro, start; omit to list the sections"New value: +"A section id or a short name such as integrate, browser, backend, server-side, pro, start, geometry, part-order, geometry-mistakes, design, references, assembly, ifc, ifc-order, ifc-mistakes; omit to list the sections"
  2. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive/openWorld=false, so safety is covered. The description adds the key behavioral fact that omitting the topic lists sections rather than returning an error, which the annotations cannot express. It stops short of describing return format or content size.

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?

Front-loaded with the resource and topic catalog, then usage rules, with no filler or marketing language. It is dense and the topic catalog is long, but every clause maps a topic to its content, so the length is largely justified.

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 single optional-parameter, read-only lookup with no output schema, the description covers what is queried, the default no-topic behavior, and when to consult which section. The one omission is any indication of what the returned guide content looks like, which the absent output schema would otherwise require.

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% and the schema already enumerates valid topic ids, so the baseline is 3. The description goes further by explaining what each section actually contains (e.g., kernels, part-order, IFC storeys/walls/joins), which helps an agent pick the right topic rather than guess from names alone.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description names the resource concretely (sections of the public guides) and enumerates the four content areas (integrate/building, geometry, design, ifc), so an agent knows exactly what this tool surfaces. It never names a sibling or states a verb for the tool itself ('Without a topic it lists the sections' is the closest), so it is clear but not fully differentiated from search/get_examples/fetch.

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 when-to-use triggers: read 'integrate' before recommending where geometry should run, 'geometry' before writing geometry code, 'design' before writing a design document, 'ifc' before writing an IFC model. It also states the default behavior when no topic is supplied, so an agent knows both the precondition and the fallback.

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.