Skip to main content
Glama

Read Brief

get_brief
Idempotent

Use this when you need a Shoot Board brief by brief_id: its looks, automations, credit quote (quote.total_credits), status and revision. Shows it on the board; spends nothing.

Input Schema

NameRequiredDescriptionDefault
board_idYesThe open Shoot Board's board_id, from Open Shoot Board or your context.
brief_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed7 schema fields changed
    • addedInput schema / additionalProperties
      Added value: +false
    • removedInput schema / description
      Removed value: -"Input schema for loading a persisted brief for UI rehydration."
    • addedInput schema / properties / board_id
      Added value: +{
      +  "description": "The open Shoot Board's board_id, from Open Shoot Board or your context.",
      +  "type": "string"
      +}
    • removedInput schema / properties / brief_id / description
      Removed value: -"Real persisted brief ID to load unchanged. Do not use 0, guessed IDs, or this tool for editing a visible brief."
    • removedInput schema / properties / brief_id / exclusiveMinimum
      Removed value: -0
    • addedInput schema / properties / brief_id / minimum
      Added value: +1
    • changedInput schema / required
      Previous value: -[
      -  "brief_id"
      -]New value: +[
      +  "brief_id",
      +  "board_id"
      +]
  2. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations already specify non-destructive, idempotent, and closed-world behavior. The description adds useful context by noting that it shows the brief on the board and spends no credits, and it names the returned fields. It does not explain permissions or any other side effects, but with annotations present this is reasonably transparent.

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 two short sentences, front-loads the usage condition, and packs the returned fields and side-effect constraints into minimal text. Every sentence earns its place.

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?

With no output schema, the description usefully lists the main returned fields and notes the zero-credit behavior. The required board_id is covered by the input schema, while brief_id is at least named in the description. It is complete enough for a simple getter, though not exhaustive about output shape or error cases.

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 50%: board_id is described in the schema, while brief_id has no schema description. The description compensates partially by saying the brief is retrieved by brief_id, but it does not discuss board_id or add further parameter guidance. This is adequate but incomplete.

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 states a specific verb and resource: get a Shoot Board brief by brief_id. It also lists what is returned (looks, automations, credit quote, status, revision), so the tool's purpose is clear. It does not explicitly distinguish itself from siblings such as list_briefs or read_shoot_board, which keeps it at 4.

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 opening 'Use this when you need...' gives a clear usage context. However, it does not state when not to use it or name alternatives such as list_briefs or read_shoot_board, so it falls short of full routing guidance.

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