Skip to main content
Glama

get_brief

Read-only

Read the default project brief to access current project requirements and context. Optionally retrieve a rendered Markdown version for a formatted view.

Instructions

Read the default project brief.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
includeMarkdownNoWhen true, also return the brief's rendered Markdown alongside the parsed record. Default false.
Behavior3/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, covering the safety profile. The description adds the scope 'default project brief' but does not disclose return format, error behavior, or other operational details. With annotations present, a score of 3 reflects the minimal additional context.

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 a single, concise sentence that immediately conveys the tool's purpose. No unnecessary words or repetition; it is appropriately front-loaded.

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?

For a simple read-only tool with one optional parameter and strong annotations, the description is mostly adequate. However, it does not explicitly state the return value (e.g., parsed record) despite having no output schema. The parameter schema hints at the parsed record, so the gap is minor.

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?

The sole parameter includeMarkdown is fully documented in the schema (100% coverage), explaining its effect and default. The description itself does not discuss parameters, but the baseline is 3 due to high schema coverage.

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 uses the specific verb 'Read' and the resource 'default project brief', clearly stating its action. The word 'default' distinguishes it from the sibling 'get_targeted_brief' and 'list_briefs'.

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

Usage Guidelines3/5

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

The description implies usage (read the default brief) but does not explicitly state when to use this tool versus alternatives like get_targeted_brief or list_briefs. No exclusions or alternative references are provided.

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/coldlogicAI/3notch'

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