Skip to main content
Glama

Tommos

Write a Playbook page

write_a_playbook_page

Write a Playbook page: facts about the company — what it sells, to whom, its prices and its people — never orders to a tommo. Without id a new page is made (under parent_id when given); with id the page's title and words are replaced. body is plain text (lines starting «- » become a list). Each save is kept as a revision.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNo
bodyNo
titleNo
parent_idNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnly=false, destructive=false and idempotent=false, so the safety profile is covered; the description adds value beyond that by disclosing that an id-based save replaces the existing title and words, that every save is retained as a revision, and that body is interpreted as plain text with «- » lines becoming list items. It does not mention permissions, response shape, or concurrent-edit behavior.

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 its content rule, then the create/update branch, then the body format and revision note. Dense and mostly waste-free, though the parenthetical 'never orders to a tommo' aside and the guillemet example are stylistic filler rather than operational detail.

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?

No output schema and zero required parameters, so the description is the agent's only source; it covers creation, update, placement, body encoding and revision retention, which is close to sufficient for this tool. Missing only return/error behavior and the create-path handling of title, which are minor for a plain save operation.

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?

With 0% schema description coverage the description must carry all four parameters, and it does: id (create vs replace switch), parent_id (placement on creation only), body (plain text with list syntax), and title (replaced when id is given). Minor gap: it never states whether title is required on creation or what happens if body is omitted.

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+resource (write a Playbook page) and defines the content domain ('facts about the company — what it sells, to whom, its prices and its people — never orders to a tommo'), which cleanly separates it from write_to_a_tommo_on_a_deal and from read_a_playbook_page. An agent can distinguish it from add_playbook_pages and propose_playbook_pages without opening either schema.

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 an explicit branch condition: no id creates a page (optionally under parent_id), with id replaces title and body. That is real when-to-use guidance for create-vs-update, but it does not name or rule out the near siblings (add_playbook_pages, propose_playbook_pages) that an agent must choose between.

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