Skip to main content
Glama
christianclaudio

mcp-server-sigma

Elements Get Doc Page

elements_get_doc_page
Read-only

Fetch a Sigma documentation page as clean Markdown by passing its page slug or section path, returning the full page content.

Instructions

Fetch a specific Sigma documentation page as clean Markdown. Pass the page slug (e.g. 'create-a-workbook') or a section path (e.g. 'docs/create-a-workbook'). Returns the full page content.

read_only_hint: True

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
page_slugYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv2.0.4

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, openWorldHint=true, destructiveHint=false, so the safety profile is covered. The description adds the output format ('clean Markdown', 'full page content'), which is modest extra context, but says nothing about failure behavior for unknown slugs or page size limits.

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?

Three short sentences, front-loaded with the action, with examples inlined rather than bulked out. The final 'Returns the full page content' sentence is mild redundancy given an output schema exists.

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?

A one-parameter fetch tool with an output schema needs only to define the input form and the action, both of which are present. The remaining gap is routing guidance against elements_search_docs, which is minor for a tool this simple.

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 0%, so the description must carry the parameter. It does: two concrete accepted forms are given ('create-a-workbook' or 'docs/create-a-workbook'), which resolves the ambiguity of what a 'slug' means here. Slightly short of 5 since format constraints (case, allowed characters) aren't specified.

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 ('Fetch a specific Sigma documentation page as clean Markdown'), which is clearly distinct from mutation siblings. It doesn't explicitly name the closest sibling, elements_search_docs, so the retrieval-vs-search distinction is left implicit.

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 requirement to supply a slug or section path implies the page must already be known, which hints at when to use this over a search tool, but no alternative is named and no when-not guidance is given. Usage is inferable rather than stated.

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

Deploy Server

Other Tools