Skip to main content
Glama

brief_save

Save a public Nogra brief draft by parsing markdown or structured input, validating it, and returning local draft writes.

Instructions

Save a public Nogra brief draft.

    Parses markdown or structured input, normalizes it to the public brief schema, validates it, and returns
    localWrites for the caller-owned `.nogra/` draft store. In hosted mode, this tool does not rely on persistent
    server-side draft storage.

    When to use:
    - Create or update a caller-owned brief draft through the MCP tool interface.
    - Convert a markdown brief into public structured brief JSON before promotion.

    When NOT to use:
    - Do not use this to mark a brief ready; use brief_promote for promotion.
    - Do not use this for run updates or events; use the run/event tools for those substrates.

    Examples:
    >>> brief_save({"title": "Import audit", ...}, source="cli")
    {"schema": "nogra.brief.v1", "releaseVersion": "v1.0.0", "briefId": "brief-...", "status": "draft", "path": ".nogra/briefs/drafts/brief-....json", ...}
    

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
sourceNoOptional source label stored in public brief metadata.
payloadYesBrief payload as markdown, JSON string, or structured object.
brief_idNoOptional existing or explicit brief id to save as a draft.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior4/5

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

No annotations are present, so the description carries the full burden. It discloses that in hosted mode there is no persistent server-side storage and that it returns localWrites. However, it does not mention side effects, idempotency, or error behavior, which would improve transparency.

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 well-structured with clear sections and an example. It is appropriately concise, though the example adds some length. Every sentence adds value.

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?

Given the tool's complexity (3 parameters, output schema present), the description explains the return value structure (localWrites, path, briefId) and the tool's role in the draft lifecycle. It could mention more about error cases or state changes, but it is largely complete.

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 description coverage is 100%, so the baseline is 3. The description does not add significant semantic information beyond the schema's property descriptions; it only repeats the function of source as an optional label. The example indirectly shows usage but does not deepen parameter understanding.

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?

The description clearly states it saves a Nogra brief draft, parses input, and returns localWrites. It distinguishes from siblings like brief_promote and run/event tools, making the purpose explicit.

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?

Provides explicit 'When to use' and 'When NOT to use' sections, including alternatives such as brief_promote and run/event tools. This gives clear guidance on when to invoke this tool versus others.

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