Skip to main content
Glama

get_component_quick_ref

Retrieve a full quick reference for a web component's API: attributes, methods, events, slots, CSS, and anti-patterns. Use first to prevent errors.

Instructions

Returns a complete quick reference for a web component — all attributes with types and valid enum values, methods, events, slots, CSS custom properties with examples, CSS parts with ::part() selectors, a ready-to-use CSS snippet, Shadow DOM warnings, and antiPatterns (component-specific "don't do this" negative examples using real tag/part/token names). Use this as the FIRST call when working with any web component to get the complete API surface and avoid common mistakes.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
libraryIdNoOptional library ID to target a specific loaded library instead of the default.
tagNameYesThe custom element tag name (e.g. "sl-button").
Behavior2/5

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

No annotations are provided, so the description must fully disclose behavior. It describes what the tool returns but does not mention any side effects, idempotency, authorization requirements, error conditions, or performance characteristics. For a read operation that might depend on loaded libraries (implied by optional libraryId), this is insufficient.

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 a single, dense sentence that front-loads the purpose and lists all returned elements efficiently. While it is packed, it avoids redundancy and every item is meaningful. Could be slightly improved with bullet points but already very concise.

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?

Given the complexity of the tool (returns many different types of information) and no output schema, the description does a good job enumerating what is included. It covers the major categories and adds context about antiPatterns and Shadow DOM warnings. However, it doesn't specify the structure or format of the output.

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% with both parameters described. The description adds no additional meaning beyond the schema. The baseline of 3 is appropriate as the schema already does the heavy lifting.

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?

Description specifies exact resources returned (attributes, methods, events, slots, CSS properties, parts, snippet, warnings, antiPatterns) with a specific verb 'Returns'. Distinguishes from sibling tools like get_component (just component info) or list_events (only events) by being comprehensive.

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

Usage Guidelines4/5

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

Explicitly states 'Use this as the FIRST call when working with any web component', providing clear when-to-use guidance. Though it doesn't explicitly say when-not-to-use, the context implies other tools like check_slot_children or list_events are for deeper analysis after this initial reference.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/bookedsolidtech/helixir'

If you have feedback or need assistance with the MCP directory API, please join our Discord server