Skip to main content
Glama

get_quick_reference

Access a cheat sheet for component development to quickly reference specifications and guidelines while building UI components.

Instructions

Get a quick reference cheat sheet for component development

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • The handler function that returns a hardcoded quick reference cheat sheet covering component structure, naming conventions, className order, data attributes, accessibility requirements, and a pre-ship checklist.
    function handleGetQuickReference(): ToolResult {
      const text = `# Component Rules Quick Reference
    
    ## Component Structure
    \`\`\`tsx
    export type ComponentProps = React.ComponentProps<'element'> & {
      variant?: 'default' | 'secondary';
    };
    
    export const Component = ({ className, variant, ...props }: ComponentProps) => (
      <element
        data-slot="component-name"
        data-state={state}
        className={cn(variants({ variant }), className)}
        {...props}
      />
    );
    \`\`\`
    
    ## Naming Conventions
    | Sub-Component | Use For |
    |---------------|---------|
    | Root | Main container with context |
    | Trigger | Opens/toggles something |
    | Content | Main content area |
    | Item | Individual item wrapper |
    | Header/Footer | Top/bottom sections |
    | Title/Description | Text elements |
    
    ## Class Order (IMPORTANT)
    \`\`\`tsx
    className={cn(
      'base-styles',           // 1. Base
      variantStyles,           // 2. Variants
      isActive && 'active',    // 3. Conditionals
      className                // 4. User overrides LAST
    )}
    \`\`\`
    
    ## Data Attributes
    - \`data-slot="button"\` - Component identification
    - \`data-state="open"\` - Visual state
    - \`data-variant={variant}\` - Current variant
    
    ## Accessibility Must-Haves
    - Button type: \`<button type="button">\`
    - Icon buttons: \`aria-label="Description"\`
    - Expandable: \`aria-expanded={isOpen} aria-controls="id"\`
    - Interactive divs: \`role="button" tabIndex={0} onKeyDown\`
    
    ## Pre-Ship Checklist
    - [ ] Extends React.ComponentProps
    - [ ] Exports types
    - [ ] {...props} spread LAST
    - [ ] Uses cn() utility
    - [ ] Has data-slot
    - [ ] Keyboard accessible
    - [ ] ARIA attributes
    - [ ] Design tokens (no hardcoded colors)
    `;
    
      return {
        content: [{ type: 'text', text }],
      };
    }
  • Registration of the 'get_quick_reference' tool in the getToolDefinitions() array, including its name, description, and input schema (no required parameters).
    {
      name: 'get_quick_reference',
      description: 'Get a quick reference cheat sheet for component development',
      inputSchema: {
        type: 'object',
        properties: {},
      },
    },
  • Dispatch case in the executeTool switch statement that routes calls to the handleGetQuickReference handler.
    case 'get_quick_reference':
      return handleGetQuickReference();
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It mentions 'Get' which implies a read operation, but doesn't specify if it's safe, requires authentication, has rate limits, or what the output format might be. This leaves significant gaps in understanding how the tool behaves.

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 a single, clear sentence that efficiently conveys the tool's purpose without any wasted words. It is appropriately sized and front-loaded, making it easy to understand at a glance.

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

Completeness2/5

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

Given the lack of annotations and output schema, the description is incomplete. It doesn't explain what the cheat sheet contains, how it's formatted, or any behavioral traits like safety or performance. For a tool with no structured data to rely on, more context is needed to fully understand its use.

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?

The tool has zero parameters, and the schema description coverage is 100%, so there's no need for the description to add parameter details. The baseline score for zero parameters is 4, as the description doesn't need to compensate for any missing schema information.

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?

The description clearly states the action ('Get') and resource ('quick reference cheat sheet for component development'), making the purpose understandable. However, it doesn't differentiate this tool from sibling tools like 'get_specification' or 'get_template', which might also provide reference materials, so it doesn't reach the highest score.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives like 'get_specification' or 'get_template', nor does it mention any prerequisites or context for usage. It only states what the tool does, without indicating appropriate scenarios.

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/getlokiui/components-build-mcp'

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