Skip to main content
Glama

Get the writing brief

get_brief
Read-only

The writing brief for a deck whose outline is already saved.

Input Schema

NameRequiredDescriptionDefault
deck_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • removedInput schema / properties / guest_token
      Removed value: -{
      -  "description": "Only for a deck created WITHOUT an account: the guest_token create_deck returned.",
      -  "maxLength": 80,
      -  "type": "string"
      -}
  2. First observed

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is covered. The description adds the useful precondition that an outline must already be saved, but does not describe return format, auth, or rate limits.

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 a single concise sentence with no filler. It is not front-loaded with a verb, but it wastes no words and communicates the core resource and precondition immediately.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple read-only retrieval tool with annotations covering safety, the description gives the purpose and a key precondition. It remains incomplete on parameter meaning and sibling routing (e.g., get_page_brief), which an agent would need for confident selection.

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

Parameters2/5

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

With one required parameter and 0% schema description coverage, the description must carry the explanation. It only implies 'deck' maps to deck_id and gives no semantics, format, or constraint details (e.g., min/max length).

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 identifies the resource ('writing brief') and scopes it to a deck rather than a page, which helps distinguish it from get_page_brief. However, it is a noun phrase without an explicit verb and does not name the sibling it contrasts with.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It states a precondition ('whose outline is already saved'), which implies the tool is used after outline creation. But it does not say when to use this instead of alternatives like get_page_brief or write_outline, nor any exclusions.

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.