Skip to main content
Glama

brief_read

Read a public Nogra brief by ID, first checking draft JSON, then falling back to promoted markdown.

Instructions

Read a public Nogra brief by id.

    Reads draft JSON first and falls back to matching promoted markdown when no draft exists.

    When to use:
    - Retrieve a saved or promoted public brief through tools.
    - Verify the current status and path for a known brief id.

    When NOT to use:
    - Do not use this to list recent briefs; use recent_briefs.
    - Do not use this to validate arbitrary unsaved input; use brief_validate.

    Examples:
    >>> brief_read("brief-import-audit-2026-05-06-a1b2c3")
    {"status": "ok", "brief": {...}, "path": ".nogra/briefs/BRIEF-import-audit-2026-05-06.md"}
    

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
brief_idYesBrief id to read from draft storage first, then promoted markdown fallback.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior4/5

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

Describes fallback behavior (draft JSON first, then promoted markdown) and example output shows status and path. No annotations provided, so description carries burden; it is mostly transparent but lacks explicit read-only declaration.

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?

Well-structured with sections, examples, and clear language. Not overly verbose, but could be slightly more concise; however, every sentence adds value.

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?

Given one parameter and an output schema, description covers purpose, usage context, fallback behavior, and example. No obvious gaps; complete for this tool.

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%, so baseline is 3. Parameter description in schema already covers the brief_id purpose. Description adds minimal extra meaning beyond schema.

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?

Clearly states 'Read a public Nogra brief by id' with fallback logic. Distinguishes from siblings by explicitly listing when not to use (e.g., recent_briefs, brief_validate).

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

Usage Guidelines5/5

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

Explicit 'When to use' and 'When NOT to use' sections with specific alternative tools (recent_briefs, brief_validate). Provides clear context for when this tool is appropriate.

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/nograai/nogra-mcp'

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