Skip to main content
Glama

build_rich_doc

Create a formatted Google Doc from structured blocks, adding banners, section boxes, callouts, and colored code blocks. Specify a Drive folder to control where the document is saved.

Instructions

Build a formatted Google Doc — banners, section boxes, callouts, coloured code blocks.

blocks is the document's content in the generator's block form; read the gws-richdoc skill for the shapes. folder_id is a Drive folder; omitted, the doc lands in the default location and the answer says where.

Needs the gws CLI on this machine; without it the call fails with that message rather than producing a broken document.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYes
blocksYes
folder_idNo
Behavior4/5

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

With no annotations provided, the description bears the full burden of disclosure. It reveals that the tool fails fast if the `gws` CLI is missing, and that an omitted `folder_id` places the doc in the default location with a follow-up response. This is valuable, but it doesn't cover other behavioral traits like permissions or the full return shape, so a 4 is appropriate.

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 compact and front-loaded with the main purpose. Each sentence earns its place: one for purpose, one for parameter semantics, and one for the CLI prerequisite and failure mode. No fluff or repetition.

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 3-parameter tool with no annotations and no output schema, the description covers the core purpose, explains two of three parameters, states the environment requirement, and hints at the response behavior. It could be more explicit about the exact return value, but it provides enough context for an agent to use the tool correctly.

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 schema has 0% description coverage, but the description compensates by explaining `blocks` as the generator block form and pointing to the `gws-richdoc` skill, and `folder_id` as a Drive folder with default-location behavior. The `name` parameter is left to inference from its schema title, but overall the description adds meaningful meaning beyond raw schema.

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 opens with a specific action ('Build a formatted Google Doc') and lists visual elements (banners, boxes, callouts, coloured code blocks), making the tool's purpose clear. It does not explicitly differentiate from sibling tools like gws-doc or gws-richdoc, so it stops short of a 5.

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 description gives concrete guidance: how to fill `blocks`, what happens when `folder_id` is omitted, and a hard prerequisite (the `gws` CLI) with failure behavior. It does not mention alternatives or when-not-to-use this tool, but it provides clear enough context for invoking it.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/Canvas-LMS-MCP/canvas-teacher-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server