Skip to main content
Glama

ionic-framework-mcp

by io.capawesome
OverviewAdmin

Read component usage examples

get_component_usage
Read-only

Read the official usage examples of one Ionic Framework component, as published on its documentation page. Use this before writing markup for a component to see how it is actually used in Angular, React, Vue or vanilla JavaScript — the template, the component class and the styles that belong together. Call it without an example first to see which examples the component offers. Returns the examples of the component with the frameworks each provides, or, when an example is given, its code per framework as fenced code blocks — one section per framework, and one block per file where an example spans several files. Do not use this for the component's API reference: its properties, events, methods, CSS shadow parts, CSS custom properties and slots are on the documentation page, which get_doc_page returns.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
exampleNoThe id of one example, e.g. "basic" or the nested "presentation/date". Defaults to listing the examples of the component instead of returning code. Optional.
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.
componentYesThe component to read the examples of, e.g. "button". The tag is accepted too, e.g. "ion-button".
frameworkNoOptional. The framework to return the example for, e.g. "react". Match the framework of the user's project. Defaults to returning every framework the example provides.

Schema Changelog

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

  1. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, openWorldHint, and destructiveHint, so the bar is lower. The description adds useful behavioral details about return types (code per framework, fenced blocks) and default behaviors (version, framework), without contradicting the annotations.

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?

The description is well-structured and front-loaded with the main purpose, followed by usage context and return details. While moderately long, it avoids redundancy and every sentence contributes essential information.

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?

Since there is no output schema, the description thoroughly explains what the tool returns (examples list or code per framework, fenced blocks, per-file sections). It also covers version and framework matching and points to the sibling get_doc_page for API reference, making it complete for an agent to use correctly.

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 coverage is 100% and each parameter has a descriptive comment including defaults. The description adds minimal extra meaning beyond the schema, primarily reiterating the example default and usage. It does not significantly deepen understanding of parameter semantics beyond what is already present.

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 official usage examples of an Ionic Framework component, specifying the action (read) and resource (usage examples). It also distinguishes itself from siblings by explicitly noting not to use it for API reference, which is handled by get_doc_page.

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?

Provides explicit when-to-use guidance ('Use this before writing markup for a component') and when-not-to-use ('Do not use this for the component's API reference'). It also advises calling without an example first to list available examples, giving clear operational direction.

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

All ionic-framework-mcp toolsInspect
Try in Browser
RayrunBuild, deploy, and operate MCP servers without becoming an infrastructure team.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources