Skip to main content
Glama

brief_promote

Convert a saved brief draft into a ready markdown artifact by validating and promoting it, returning local writes and a stable path.

Instructions

Promote a saved public Nogra brief draft.

    Marks a draft ready, validates it, renders markdown, and returns localWrites for the promoted brief artifact.
    Hosted/plugin mode should pass the inline brief payload because the customer's local `.nogra/` store is the
    authority.

    When to use:
    - Convert a valid draft payload into a ready markdown brief artifact.
    - Produce a stable promoted brief path while keeping draft JSON readable.

    When NOT to use:
    - In hosted/plugin mode, do not rely on server-side draft state; pass the local draft payload inline.
    - Do not use this to edit a draft; use brief_save for updates.

    Examples:
    >>> brief_promote("brief-import-audit-2026-05-06-a1b2c3", payload={...})
    {"draft": {...}, "brief": {...}, "path": ".nogra/briefs/BRIEF-import-audit-2026-05-06.md"}
    

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
payloadNoOptional inline brief payload. Required in hosted/stateless mode when promoting customer-local drafts.
brief_idNoBrief draft id to promote, normally shaped like brief-<slug>-<date>-<hex>.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior4/5

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

Discloses major behaviors: marks ready, validates, renders markdown, returns localWrites. No annotations provided, so description carries full burden; it covers the core actions but could mention idempotency or side effects.

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?

Concise, well-structured with separate sections for purpose, behavior, usage guidelines, and a clear example. 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 the tool's simplicity (2 optional params, output schema exists), the description covers purpose, parameters, behavior, and returns via example. No gaps.

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

Parameters4/5

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

Schema coverage is 100%, so baseline is 3. Description adds practical guidance about when payload is required (hosted mode) and brief_id shape, raising above baseline.

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 promotes a saved public Nogra brief draft, and distinguishes from siblings like brief_save by explicitly saying not to use this for edits.

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 (convert draft, produce stable path) and when-not-to-use (hosted/plugin mode rely on local payload; not for editing) with alternative tool brief_save.

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