MCP Vue Server

A Model Context Protocol (MCP) server that provides Vue.js documentation search capabilities using Algolia's search API.

Features

• 🔍 Search Vue.js documentation using Algolia
• 📚 Access to official Vue.js documentation
• 🚀 Fast and accurate search results
• 🔧 Easy integration with MCP clients

Installation

Global installation (recommended)

npm install -g vue-mcp-server

Local installation in a project

npm install vue-mcp-server

Usage

Via the executable (recommended)

Once installed, you can run the server directly:

# If installed globally
vue-mcp-server

# If installed locally in a project
npx vue-mcp-server

# Or via npm run (without additional configuration)
npm run vue-mcp-server

Via programmatic import

import { VueServer } from 'vue-mcp-server';

const server = new VueServer({
  name: 'my-server',
  algoliaApiKey: process.env.ALGOLIA_API_KEY
});

await server.run();

Configuration via environment variables

You can configure the server via environment variables:

# Configure Algolia keys
export ALGOLIA_API_KEY="your-api-key"
export ALGOLIA_APP_ID="your-app-id"
export ALGOLIA_INDEX_NAME="vuejs"

# Then run the server
vue-mcp-server

API

The server implements the Model Context Protocol and provides:

Tools

search_vue_documentation

Searches Vue.js documentation using Algolia's search API.

Parameters:

• query (string): Search query

Returns:

• Search results with titles, content snippets, and URLs
• Fallback to local documentation sections if Algolia is unavailable

Development

Prerequisites

• Node.js 18+
• npm or pnpm

Setup

# Clone the repository
git clone <repository-url>
cd vue-mcp-server

# Install dependencies
npm install

# Build the project
npm run build

Scripts

• npm run build: Compile TypeScript to JavaScript
• npm start: Start the MCP server
• npm run start-client: Start the MCP client for testing

License

MIT

Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests if applicable
5. Submit a pull request

Support

For issues and questions, please open an issue on the GitHub repository.