Skip to main content
Glama

how-to-use

Learn to use Vite's Hot Module Replacement and checkpoint features for real-time code updates during development with the Vite MCP Server.

Instructions

Description of how to use the server

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
sectionYesSection to describe

Implementation Reference

  • The execution logic for the 'how-to-use' tool, returning markdown content with instructions based on the provided section.
        }, ({ section }) => {
          switch (section) {
          case 'checkpoint':
            return {
              content: [
                { type: 'text', text: `
    You can use checkpoint features by inserting '<meta name="__mcp_checkpoint" data-id="">' into the head to create a named snapshot of the current state.
    
    The data-id attribute is a unique identifier for the checkpoint.
    
    Console logs generated in the browser while a checkpoint is active are tagged with the checkpoint ID and can be queried individually.
    
    Note: Since hot reload is triggered when files are saved, carefully consider the sequence between meta tag changes and the changes you want to observe. Make sure to set the checkpoint meta tag before making the changes you want to track.` }
              ]
            };
          case 'hmr':
            return {
              content: [
                { type: 'text', text: `
    If the HMR connection is established with the client, the server will automatically gather HMR events and provide them to the client.
    
    You can read the HMR events using the 'get-hmr-events' tool.
    
    The HMR connection is optional.
    
    If your development environment does not support HMR, you cannot read HMR events, but you can still check the results of file modifications by using 'execute-browser-commands' to refresh the page.` }
              ]
            };
          default:
            return {
              content: [
                { type: 'text', text: 'Invalid section' }
              ]
            };
          }
        });
  • The input schema definition for the 'how-to-use' tool, specifying the 'section' parameter.
    server.tool('how-to-use', 'Description of how to use the server', {
      section: z.enum(['checkpoint', 'hmr']).describe('Section to describe'),
    }, ({ section }) => {
  • src/index.ts:41-41 (registration)
    The registration of the 'how-to-use' tool on the MCP server instance.
    server.tool('how-to-use', 'Description of how to use the server', {
Behavior1/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. However, it offers no information about what the tool does beyond its vague purpose—no details on whether it's read-only, destructive, requires specific permissions, returns structured data, or has any behavioral traits. This leaves the agent with no actionable insights.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness2/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single sentence, but it's under-specified rather than concise—it wastes its few words on a tautology without providing useful information. It fails to be front-loaded with critical details, making it inefficient and unhelpful for an AI agent trying to understand the tool's role.

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

Completeness1/5

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

Given the complexity implied by the tool name and sibling context (browser automation tools), the description is completely inadequate. With no annotations, no output schema, and a vague purpose, it doesn't explain what the tool returns, how it interacts with the server, or why it exists among browser-focused tools, leaving significant gaps in understanding.

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 has 100% description coverage, with the single parameter 'section' clearly documented as an enum with values 'checkpoint' and 'hmr'. The description adds no additional meaning beyond this, but since the schema fully covers the parameters, the baseline score of 3 is appropriate as the schema does the heavy lifting.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose2/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description 'Description of how to use the server' is a tautology that essentially restates the tool name 'how-to-use' without specifying what action it performs or what resource it targets. It doesn't distinguish this tool from its siblings, which are all browser automation tools, leaving the purpose vague and unhelpful for an AI agent.

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

Usage Guidelines1/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. Given the sibling tools are all browser-related (e.g., 'capture-screenshot', 'execute-browser-commands'), it's unclear if this tool is for general server usage instructions, browser-specific help, or something else, making it misleading without any context.

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/ESnark/blowback'

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