Vue Prime

You set up an MCP server to expose PrimeVue documentation through a lightweight API so you can query key pages, full docs, and individual component references from your client or AI tools. This server caches content for fast access and provides simple HTTP endpoints you can connect to from MCP clients.

How to use

You connect an MCP client to the server over HTTP to access three main resources. Retrieve a structured list of key pages at /llms.txt, the full PrimeVue documentation at /llms-full.txt, and the Markdown documentation for a specific component at /components/{component}.md. The server is designed to be network-friendly and easy to wire into your AI workflows.

How to install

pnpm install

pnpm run build

Additional configuration and usage notes

The server runs as an HTTP service by default and is reachable over the network on port 3000. You can run it in development or production mode using the provided commands.

Quick start steps to get up and running locally:

• Install dependencies and build the project
• Start the server in development or production mode
• Verify the health endpoint is responding
• Connect an MCP client using the local MCP URL path "/mcp" on port 3000

End-to-end quick reference

{
  "mcpServers": {
    "vue_prime_mcp": {
      "type": "http",
      "url": "http://localhost:3000/mcp",
      "args": []
    }
  },
  "envVars": [
    {"name": "PORT", "description": "Port to bind the server", "example": "8080"},
    {"name": "HOST", "description": "Host to bind the server", "example": "0.0.0.0"}
  ]
}

Security and deployment notes

The server operates in a stateless manner, with each request processed independently. For deployments, you can set PORT and HOST via environment variables to tailor the binding address and port, and you should ensure the MCP endpoint is accessible from your client network.

Troubleshooting

If the health check fails, verify that the server is running, the port is reachable, and that the MCP endpoint URL used by your client matches the running service path. Check that the server has finished building before starting in production mode and that your network allows traffic on the configured port.

Notes

The server exposes the official PrimeVue MCP endpoints and caches loaded documentation for faster access on subsequent requests.

Available tools

get-primevue-component

Fetches the documentation for a specific PrimeVue component in Markdown format from the official source.

get-primevue-llms-txt

Retrieves a structured list of key PrimeVue documentation pages.

get-primevue-llms-full-txt

Retrieves the complete PrimeVue documentation text.

search-primevue-docs

Searches the full PrimeVue documentation for a keyword or phrase.

primevue-help

Creates a prompt template to request help on a PrimeVue topic.