MCP Advisor

English | 简体中文

Introduction

MCP Advisor is a discovery and recommendation service that helps AI assistants explore Model Context Protocol (MCP) servers using natural language queries. It makes it easier for users to find and leverage MCP tools suitable for specific tasks.

Features

• Natural Language Search: Find MCP services using conversational queries

• Rich Metadata: Get detailed information about each service

• Real-time Updates: Always in sync with the latest MCP services

• Easy Integration: Simple configuration for any MCP-compatible AI assistant

• Hybrid Search Engine: Advanced search capabilities combining vector search and text matching

• Multi-provider Support: Support for multiple search providers executing in parallel

Documentation Navigation

• Installation Guide - Detailed installation and configuration instructions

• User Guide - How to use MCP Advisor

• Architecture Documentation - System architecture details

• Technical Details - Advanced technical features

• Developer Guide - Development environment setup and code contribution

• Best Practices - Coding standards and best practices for contributors

• Troubleshooting - Common issues and solutions

• Search Providers - Search provider details

• API Reference - API documentation

• Roadmap - Future development plans

• Contribution Guidelines - How to contribute code

Quick Start

Installation

The fastest way is to integrate MCP Advisor through MCP configuration:

Add this configuration to your AI assistant's MCP settings file:

• MacOS/Linux: ~/Library/Application Support/Claude/claude_desktop_config.json

• Windows: %AppData%\Claude\claude_desktop_config.json

For more installation methods, see the Installation Guide.

Demo

Developer Guide

Architecture Overview

MCP Advisor adopts a modular architecture with clear separation of concerns and functional programming principles:

Core Components

1. Search Service Layer

   • Unified search interface and provider aggregation

   • Support for multiple search providers executing in parallel

   • Configurable search options (limit, minSimilarity)

2. Search Providers

   • Meilisearch Provider: Vector search using Meilisearch

   • GetMCP Provider: API search from the GetMCP registry

   • Compass Provider: API search from the Compass registry

   • Offline Provider: Hybrid search combining text and vectors

3. Hybrid Search Strategy

   • Intelligent combination of text matching and vector search

   • Configurable weight balancing

   • Smart adaptive filtering mechanisms

4. Transport Layer

   • Stdio (CLI default)

   • SSE (Web integration)

   • REST API endpoints

For more detailed architecture documentation, see ARCHITECTURE.md.

Technical Highlights

Advanced Search Techniques

1. Vector Normalization

   • All vectors are normalized to unit length (magnitude = 1)

   • Ensures consistent cosine similarity calculations

   • Improves search precision by focusing on direction rather than magnitude

2. Parallel Search Execution

   • Vector search and text search run in parallel

   • Leverages Promise.all for optimal performance

   • Fallback mechanisms enabled if either search fails

3. Weighted Result Merging

   • Configurable weights between vector and text results

   • Default: vector similarity (70%), text matching (30%)

Error Handling and Logging System

MCP Advisor implements robust error handling and logging systems:

1. Contextual Error Formatting

   • Standardized error object enrichment

   • Stack trace preservation and formatting

   • Error type categorization and standardization

2. Graceful Degradation

   • Multi-provider fallback strategies

   • Partial result processing

   • Default responses for critical failures

For more technical details, see TECHNICAL_DETAILS.md.

Developer Quick Start

Development Environment Setup

1. Clone the repository

2. Install dependencies:

   npm install

3. Configure environment variables (see INSTALLATION.md)

Library Usage

Transport Options

MCP Advisor supports multiple transport methods:

1. Stdio Transport (default) - Suitable for command-line tools

2. SSE Transport - Suitable for web integration

3. REST Transport - Provides REST API endpoints

For more development details, see DEVELOPER_GUIDE.md.

Contribution Guidelines

1. Follow commit message conventions:

   • Use lowercase types (feat, fix, docs, etc.)

   • Write descriptive messages in sentence format

2. Ensure code quality:

   • Run tests: npm test

   • Check types: npm run type-check

   • Lint code: npm run lint

For detailed contribution guidelines, see CONTRIBUTING.md.

Usage Examples

Example Queries

Here are some example queries you can use with MCP Advisor:

Example Response

For more examples, see EXAMPLES.md.

Troubleshooting

Common Issues

1. Connection Refused

   • Ensure the server is running on the specified port

   • Check firewall settings

2. No Results Returned

   • Try a more general query

   • Check network connection to registry APIs

3. Performance Issues

   • Consider adding more specific search terms

   • Check server resources (CPU/memory)

For more troubleshooting information, see TROUBLESHOOTING.md.

Search Providers

MCP Advisor supports multiple search providers that can be used simultaneously:

1. Compass Search Provider: Retrieves MCP server information using the Compass API

2. GetMCP Search Provider: Uses the GetMCP API and vector search for semantic matching

3. Meilisearch Search Provider: Uses Meilisearch for fast, fault-tolerant text search

For detailed information about search providers, see SEARCH_PROVIDERS.md.

API Documentation

For detailed API documentation, see API_REFERENCE.md.

Roadmap

MCP Advisor is evolving from a simple recommendation system to an intelligent agent orchestration platform. Our vision is to create a system that not only recommends the right MCP servers but also learns from interactions and helps agents dynamically plan and execute complex tasks.

Major Development Phases

1. Recommendation Capability Optimization (2025 Q2-Q3)

   • Accept user feedback

   • Refine recommendation effectiveness

   • Introduce more indices

For a detailed roadmap, see ROADMAP.md.

Testing

Use inspector for testing:

License

This project is licensed under the MIT License - see the LICENSE file for details.