Skip to main content
Glama

Read Brand Edit File

get_brand_edit_file
Read-onlyIdempotent

Read paginated changed Markdown from a prepared brand edit candidate. Each present side identifies its immutable base or candidate Skill and includes the SHA-256 of the complete file. Follow pagination to read the full content. Available only after a candidate exists.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "edit_id": "<edit_id>",
      "path": "<path>"
    },
    "name": "get_brand_edit_file"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYesPath of the changed Markdown file to read. Copy it from change_set.markdownChanges in the edit result.
cursorNoContinuation token returned as next_cursor for this edit_id and path. Reuse both values when requesting the next page.
edit_idYesUse edit_id returned by create_brand_edit to identify the Brand Edit draft.
llm_modelNoThe model identifier you are running as, for example "claude-opus-4-8" or "gpt-5.2". Omit it or pass "unknown" if you are not certain; the tool runs the same either way. Recorded only for the server developer's analytics.

Output Schema

NameRequiredDescriptionDefault
baseYes
pathYes
statusYes
edit_idYes
has_moreYes
candidateYes
operationYes
next_cursorYes
schema_versionYes
message_for_assistantNoContext, explanations, or actionable guidance for the calling assistant. Hosts may display it, but it is not copy that must be shown to the user verbatim.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already declare readOnly, idempotent, closed-world and non-destructive, so the safety profile is covered. The description adds real value with the pagination contract ('Follow pagination to read the full content') and the SHA-256 integrity detail, but leaves ambiguous what 'each present side' means and what happens when the candidate or path is absent.

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?

Four short sentences, front-loaded with the action and scope before the availability constraint. The middle sentence about immutable base/candidate Skill and SHA-256 is dense and slightly opaque, but no sentence is padding.

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?

With an output schema and full annotation coverage, the description only needs to supply preconditions and behavioral traits, and it does: candidate prerequisite, pagination follow-through, and file-integrity context. Minor gaps remain around the 'present side' wording and failure behavior.

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 description coverage is 100%, so the baseline is 3; the description adds little per-parameter beyond what the schema states (path from change_set.markdownChanges, edit_id from create_brand_edit). It does clarify the overall reading model, but parameter meaning is carried by the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource: 'Read paginated changed Markdown from a prepared brand edit candidate.' It also scopes the content as 'changed Markdown' from a candidate, which separates it from get_brand_edit's metadata view, though it never names a sibling explicitly.

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

Usage Guidelines4/5

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

Gives a clear precondition — 'Available only after a candidate exists' — and the path parameter guidance points the agent at change_set.markdownChanges from the edit result. It stops short of naming an alternative for reading the edit's summary or change list instead.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources