Skip to main content
Glama

Get a page's example

get_example
Read-only

Returns a runnable example from a FrontMCP docs page: the files of one of its Playgrounds, with their tests, as the docs run them. Without index, lists the page's Playgrounds (numbered from 1, in page order) with their section and files.

Input Schema

NameRequiredDescriptionDefault
pathYesThe page, like /reference/sdk/tool or a frontmcp.dev URL.
indexNoWhich Playground on the page, from 1.
versionNoA documented FrontMCP version, like "1.9.4", or a minor, like "1.9", for its newest patch. Pass the version resolve_version found for the project. Defaults to the version this endpoint serves.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / version / description
      Previous value: -"A documented FrontMCP version, like \"1.9.4\", or a minor, like \"1.9\", for its newest patch. Defaults to the version this endpoint serves."New value: +"A documented FrontMCP version, like \"1.9.4\", or a minor, like \"1.9\", for its newest patch. Pass the version resolve_version found for the project. Defaults to the version this endpoint serves."
  2. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, so the safety profile is covered; the description adds real value by disclosing the return shape in both modes (files with their tests as the docs run them; or a numbered list of Playgrounds with section and files). Since there is no output schema, this return-shape disclosure is doing meaningful work, though failure behavior for a bad path or out-of-range index is not mentioned.

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?

Two tight sentences, front-loaded with the primary behavior and then the fallback mode; every clause carries information. Density is high but nothing is redundant.

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 read-only lookup tool with a fully documented schema, the description covers both operating modes and the returned content, which is what an agent needs to call it correctly. Error handling and whether `version` changes the returned example set are left unspecified.

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 coverage is 100%, so 3 is the baseline, but the description adds semantics the schema lacks: omitting `index` switches the tool into a listing mode, and numbering is page-order starting at 1. That is genuine added meaning beyond the schema's 'Which Playground on the page, from 1.'

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 concrete verb and resource: it returns a runnable example (files + tests) from a FrontMCP docs page, and specifies the alternate mode when `index` is absent. This is clearly distinct from get_page or get_skill, though it never names a sibling to sharpen the boundary.

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 through the `index`-present vs `index`-absent behavior (fetch one Playground vs list them), which helps an agent pick a mode. However it gives no when-to-use guidance relative to sibling tools like get_page or search_docs, and no error/precondition 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