Skip to main content
Glama

brief_contract

Retrieve the fields, markdown anchors, and default return policy for structuring a Nogra brief before validation or save.

Instructions

Read the public Nogra brief contract.

    Returns the fields, markdown anchors, default return policy and public resources needed to draft a
    `nogra.brief.v1` brief before calling validation or save tools.

    When to use:
    - Draft a Nogra brief from user intent without guessing field names or required sections.
    - Check how markdown sections map into the structured brief object.
    - Confirm that response length policy is a return policy, not a brief length cap.

    When NOT to use:
    - Do not use this as execution approval.
    - Do not dispatch work from this contract alone; save/promote/dispatch gates still apply.

    Examples:
    >>> brief_contract(workspace_id="acme-app")
    {"schema": "nogra.brief.contract.v1", "briefSchema": "nogra.brief.v1", "requiredFields": [...]}
    

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
workspace_idNoOptional local workspaceId from .nogra/config.json. Empty uses local.

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 provided, so the description carries full burden. It states it is a read operation ('Read the public...'), describes what is returned, and gives an example. It does not mention side effects, but as a read-only contract query, that is acceptable. Slight deduction for not explicitly stating safety profile.

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?

Well-structured with clear sections: description, when to use, when not to use, examples. Every sentence serves a purpose with no redundancy.

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 presence of an output schema (has output schema: true), the description does not need to detail return values. It covers purpose, usage guidelines, and provides an example, making it complete for a contract-reading tool.

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?

Only one parameter (workspace_id) with 100% schema coverage. The description adds value by clarifying that leaving it empty uses local configuration, which goes beyond the schema's 'Optional local workspaceId' description.

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 the tool reads the public Nogra brief contract and returns fields, markdown anchors, default return policy, etc. It distinguishes itself from siblings like brief_save and brief_validate by focusing on reading the contract before validation or save.

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?

Explicitly provides when to use (draft a brief from user intent, check markdown sections, confirm return policy) and when NOT to use (not execution approval, not to dispatch work alone). This helps the agent select it correctly over alternatives.

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