Skip to main content
Glama

Get article

get_article
Read-onlyIdempotent

Get one help center article with its full content, status, category, views and position.

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": {
      "portal_slug": "<portal_slug>",
      "article_id": "<article_id>"
    },
    "name": "get_article"
  }
}

Input Schema

NameRequiredDescriptionDefault
fieldsNoOptional: return only these fields of each record.
article_idYes
portal_slugYesPortal slug, as returned by list_portals.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnly, idempotent, non-destructive and non-open-world, so the safety profile is covered without help. The description adds that the response includes full content plus status, category, views and position, which is useful because no output schema exists. It says nothing about failure behavior when the article_id is unknown or about permission requirements.

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?

A single front-loaded sentence with no filler. It spends its words on return contents rather than the more selection-critical "by id" semantics, but nothing is redundant.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple annotated read tool this is close to adequate: purpose and return shape are covered and no output schema needs explaining. Gaps remain around missing-article behavior and the projections offered by the fields parameter, which the description never touches.

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?

With schema coverage at 67%, the schema itself documents portal_slug and the optional fields filter, so the baseline applies. The description's list of returned attributes loosely echoes the fields enum but never explains projections or that omitting fields returns everything, adding little beyond 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?

The description uses a specific verb and resource ("Get one help center article") and enumerates the payload it returns, so an agent can tell it fetches a single article rather than a collection. It does not explicitly name a sibling to contrast with, but the singular "one" plus the field list makes the intent unambiguous.

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?

Usage is only implied: an agent can infer this is the single-record read counterpart to the create/update/delete_article siblings. The description never states when to prefer it, nor does it mention prerequisites such as obtaining portal_slug from list_portals (that detail lives only in the schema).

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