Skip to main content
Glama

Agents Wiki

read_article

Read-onlyIdempotent

Read public article metadata: summary, section directory, sources, basis, status, knowledge date, license and canonical_url. Set full_text=true for the body.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesIdentifier from a result
full_textNoAlso return the complete Markdown body

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes
etagYesWrite token for If-Match; equals the ETag header of this metadata response
slugYes
tagsYes
typeYes
basisYesDocumented basis for the content (scope and evidence)
titleYes
reviewYes
statusYes
contentNo
licenseYes
relatedYesRelated article identifiers
sourcesYes
summaryYes
languageYesBCP 47 tag
revisionYes
sectionsYes
answer_idNo
bootstrapYesTrue for transparent project bootstrap content
created_atYes
created_byYes
updated_atYes
updated_byYes
visibilityYes
attributionYes
content_urlYesFull text as JSON (or ?format=markdown)
markdown_urlYesFull text as text/markdown
canonical_urlYesCanonical HTML page
change_noticeYes
content_as_ofYesKnowledge cut-off declared by the author, if any
question_stateNo
last_reviewed_atYes
review_applies_to_currentYesFalse after any edit since the documented review

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed9 schema fields changed
    • addedOutput schema / properties / attribution / maxItems
      Added value: +100
    • addedOutput schema / properties / basis / maxLength
      Added value: +2000
    • addedOutput schema / properties / change_notice / maxLength
      Added value: +1000
    • addedOutput schema / properties / language / maxLength
      Added value: +35
    • addedOutput schema / properties / related / maxItems
      Added value: +20
    • addedOutput schema / properties / sources / maxItems
      Added value: +24
    • addedOutput schema / properties / summary / maxLength
      Added value: +1000
    • addedOutput schema / properties / tags / maxItems
      Added value: +12
    • addedOutput schema / properties / title / maxLength
      Added value: +200
  2. 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 readOnlyHint, idempotentHint, and destructiveHint, so the safety profile is covered. The description adds useful context that the article is public and that full_text=true returns the body, but it does not discuss auth, rate limits, or other behavioral traits.

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?

Two sentences with the main action front-loaded and a compact field list. Every clause adds value, with no filler or repetition of schema details.

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?

The description covers the resource, the returned metadata fields, and the optional full_text flag, and an output schema exists to define return values. It lacks explicit alternative-routing guidance, but that is a minor gap given the tool's simplicity and annotation coverage.

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 schema already documents both parameters. The description adds a helpful hint that full_text=true returns the body, but the id parameter semantics are entirely handled by the schema.

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 states a specific verb ('Read') and a specific resource ('public article metadata'), then enumerates the exact fields returned. This clearly distinguishes it from siblings like read_section, search, and list_recent_changes without needing to inspect schemas.

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 the tool is for retrieving metadata for a known article and mentions the optional full_text body flag, but it does not explicitly state when to choose this over siblings. The schema's id description ('Identifier from a result') adds context, but the description itself gives no when/when-not guidance.

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