Skip to main content
Glama

Playbook

by com.playbook
OverviewDiscussionsAdmin

Create note

create_note
Destructive

Add a note to a Playbook board — a sticky-note asset that holds text rather than a file. Use it to annotate a board: a brief, a caption, a to-do, context for the assets around it. Returns the finished note immediately (nothing is uploaded, so there is no polling step). Requires a token with the write scope. Tip: validate collection_token with get_board first — an unknown token silently falls back to an anonymous default board.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
tagsNoManual tags to apply on creation
textYesThe note's content
colorNoNote background as a hex code. Use a note palette colour, matched exactly including case: #ffffff, #F1F3F7, #ECEAF2, #F4EBE0, #F4EFD9, #E6EEE7, #F1E5E5, #ECEAE6. Any other value is accepted but has no dark-mode counterpart, so in dark mode the note keeps its light background under light text and is hard to read. Omit it and nothing is stored — the note renders white and reads back as `average_color: null`, which is not a failed write.
titleNoOptional title shown above the note
heightNoNote card height in pixels
statusNoStatus label to set on creation
descriptionNoOptional longer description
group_tokenNoToken of an existing GROUP asset to place the note inside
organizationNoWorkspace slug, as returned by list_organizations. Omit it when the account has a single workspace — it is then resolved from your token. Pass it only when the account has several, or when you mean a workspace other than the obvious one.
collection_tokenNoDestination board token. If omitted or unknown, Playbook silently routes to a default anonymous board — call get_board first to validate.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • addedInput schema / additionalProperties
      Added value: +false
    • removedInput schema / properties / context
      Removed value: -{
-  "description": "Explain why you are calling this tool and how it fits into the user's overall goal. This parameter is used for analytics and user intent tracking. YOU MUST provide 15-25 words (count carefully). NEVER use first person ('I', 'we', 'you') - maintain third-person perspective. NEVER include sensitive information such as credentials, passwords, or personal data. Example (20 words): \"Searching across the organization's repositories to find all open issues related to performance complaints and latency issues for team prioritization.\"",
-  "type": "string"
-}
    • changedInput schema / required
      Previous value: -[
-  "text",
-  "context"
-]New value: +[
+  "text"
+]
  2. First observed

TDQS

A4.4/5.0
Behavior5/5

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

Adds substantial context beyond the annotations: confirms the note returns synchronously with no upload/polling step, states the required `write` scope, and discloses the critical silent-failure mode where an unknown collection_token falls back to an anonymous default board. It also explains the color omission consequence (average_color: null is not a failed write). These are exactly the traps an agent needs flagged.

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 purpose, then usage, behavior, auth requirement, and the get_board tip in a logical order. Every sentence carries information, though the density makes it longer than strictly minimal for a 10-param tool.

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?

Covers creation semantics, sync return behavior, auth scope, the silent-fallback risk, and the no-output-schema case by stating what is returned. For a mutation with 10 parameters and no output schema, nothing an agent needs to call it correctly is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% and the schema descriptions are unusually detailed (color palette, organization resolution, collection_token fallback), so the schema does the heavy lifting. The description largely restates the collection_token warning rather than adding new per-parameter meaning, so baseline 3 is correct.

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 ('Add a note to a Playbook board') and immediately differentiates it from file-based siblings by defining it as 'a sticky-note asset that holds text rather than a file.' An agent can distinguish it from create_comment, add_page_element, and upload_* without opening any 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 concrete use contexts ('a brief, a caption, a to-do, context for the assets around it') and a specific prerequisite workflow: validate collection_token with get_board first. It does not name an alternative tool for cases where the agent wanted a file asset, but the usage condition is otherwise clear.

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

All Playbook 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