Skip to main content
Glama

ionic-framework-mcp

Read a documentation page

get_doc_page
Read-only

Read the full markdown of a single page of the official Ionic Framework documentation. Use this after search_docs to read a page end to end before writing markup against a component, because search snippets are deliberately short and regularly omit required setup steps. A component page carries the complete API reference of that component: its properties with types and defaults, events, methods, CSS shadow parts, CSS custom properties and slots. Returns the page title, its URL, the documentation version and the complete page markdown including code samples. Do not use this to find a page: it needs an exact URL or path, so run search_docs first. Do not use it for pages outside ionicframework.com — Capacitor and native plugins are covered by the Capacitor MCP server at https://capacitor-mcp.capawesome.io/mcp, Capawesome plugins and Capawesome Cloud by the Capawesome MCP server at https://mcp.capawesome.io/mcp.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlYesThe page URL or site-relative path, e.g. "https://ionicframework.com/docs/api/button", "api/button", "angular/navigation" or "v8/api/button". An anchor is ignored; the whole page is returned.
versionNoOptional. Ionic Framework docs version. Defaults to v9. Match the major version of @ionic/core (or @ionic/angular, @ionic/react, @ionic/vue) in the user's package.json.

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, covering the safety profile. The description adds useful behavioral details such as ignoring anchors and returning the whole page, plus the version defaulting behavior, which goes beyond just safety.

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?

The description is well-structured and front-loaded: it begins with the core action, then usage context, then details about page content and return value, and finally clear exclusions. It is concise but informative, with no fluff or redundancy.

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

Completeness5/5

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

Given the schema covers all parameters and there is no output schema, the description provides sufficient context: it mentions the returned fields (title, URL, version, markdown) and clearly scopes the tool to Ionic docs only. It also supplies enough guidance to avoid misuse.

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?

The input schema already provides thorough descriptions for both parameters, including examples for URL formats, the anchor caveat, version defaults, and matching to package.json. The main description adds no extra semantic value beyond what the schema already covers.

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 clearly states the tool reads a full documentation page from the official Ionic Framework docs, specifying the verb 'Read' and the resource. It also distinguishes itself from siblings by explicitly positioning it after search_docs and warning against using it for finding pages.

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

Usage Guidelines5/5

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

The description gives explicit when-to-use guidance: use after search_docs to read a page end-to-end before writing markup, and do not use it to find a page because it requires an exact URL. It also excludes Capacitor and external docs, making the intended usage unambiguous.

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.