Skip to main content

CLI tool to navigate and manage MCP registry servers

Project description

MCP Registry CLI

A command-line interface for navigating and managing servers from the Model Context Protocol (MCP) registry.

Features

  • 🔍 Browse MCP servers with pagination and search
  • 📊 Filter and sort servers by status, name, description
  • 📋 View detailed server information including packages and repositories
  • 📦 Install servers via CLI with npm/pip support
  • 🎨 Rich terminal output with colors and tables
  • ⌨️ Interactive CLI mode with keyboard navigation
  • 🔗 Direct access to MCP Registry API

Installation

Prerequisites

  • Python 3.8 or higher
  • pip package manager

Recommended: Using Virtual Environment

# Create and activate virtual environment
python3 -m venv mcp-registry-env
source mcp-registry-env/bin/activate  # On Windows: mcp-registry-env\Scripts\activate

# Install the package
pip install mcp-registry-cli

System-wide Installation

pip install mcp-registry-cli

From Source (Development)

# Clone the repository
git clone https://github.com/loretoparisi/mcp-registry-cli.git
cd mcp-registry-cli

# Create virtual environment
python3 -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install in development mode
pip install -e .

# Or with development dependencies
pip install -e ".[dev]"

Quick Start

Interactive Mode (Recommended)

# Start interactive CLI with keyboard navigation
mcp-registry-cli

# Alternative ways to start interactive mode
mcp-registry --interactive
mcp-registry interactive

Interactive Controls:

  • ↑/↓ or k/j - Navigate servers
  • Enter - View server details
  • i - Install server
  • s - Search servers
  • f - Filter by status
  • h - Help panel
  • q - Quit

Command Line Mode

# List first 10 servers
mcp-registry list --limit 10

# Search for GitHub-related servers
mcp-registry list --search github

# Show detailed information about a server
mcp-registry show io.github.domdomegg/airtable-mcp-server

# Preview installation commands
mcp-registry install io.github.domdomegg/airtable-mcp-server --dry-run

# Install a server (requires appropriate package manager)
mcp-registry install io.github.domdomegg/airtable-mcp-server

Command Reference

List Servers

mcp-registry list [OPTIONS]

Options:
  --limit INTEGER         Number of servers to display (default: 30)
  --cursor TEXT          Pagination cursor for next page
  --search TEXT          Search servers by name or description
  --status TEXT          Filter by status (active, inactive, deprecated)
  --sort [name|status|description]  Sort by field (default: name)
  --reverse              Reverse sort order

Show Server Details

mcp-registry show <server-name>

Example:
mcp-registry show ai.waystation/gmail

Install Server

mcp-registry install <server-name> [OPTIONS]

Options:
  --package-manager [npm|pip|auto]  Package manager to use (default: auto)
  --dry-run                        Show commands without executing

Examples

Explore the Registry

# List all active servers
mcp-registry list --status active

# Find database-related servers
mcp-registry list --search database --limit 5

# Browse with pagination
mcp-registry list --limit 10
# Use the cursor from output for next page
mcp-registry list --cursor <next-cursor>

Get Server Information

# View comprehensive server details
mcp-registry show com.pga/pga-golf

# Check available installation packages
mcp-registry show io.github.DeanWard/HAL

Install Servers

# Preview installation
mcp-registry install xcodebuildmcp --dry-run

# Install with specific package manager
mcp-registry install hal-mcp --package-manager npm

# Auto-detect and install
mcp-registry install reddit-research-mcp

Programmatic Usage

from mcp_registry_cli.api import MCPRegistryAPI

# Initialize API client
api = MCPRegistryAPI()

# List servers
result = api.list_servers(limit=10)
for server in result['servers']:
    print(f"{server.name}: {server.description}")

# Get server details
server = api.get_server_details("ai.waystation/gmail")
print(f"Status: {server.status}")
if server.packages:
    print("Available packages:")
    for pkg in server.packages:
        print(f"  - {pkg.get('registry')}: {pkg.get('package')}")

# Search servers
result = api.search_servers("github", limit=5)
print(f"Found {len(result['servers'])} GitHub-related servers")

Troubleshooting

Virtual Environment Issues

If you encounter permission errors, ensure you're using a virtual environment:

python3 -m venv mcp-registry-env
source mcp-registry-env/bin/activate
pip install --upgrade pip
pip install mcp-registry-cli

Package Installation

If server installation fails, check that you have the required package manager:

  • npm servers: Ensure Node.js and npm are installed
  • pip servers: Ensure Python and pip are available
  • Use --dry-run to preview commands before execution

API Issues

If you encounter API errors:

  • Check your internet connection
  • The MCP Registry API may be temporarily unavailable
  • Try reducing the --limit parameter

Development

Setup Development Environment

# Clone repository
git clone https://github.com/loretoparisi/mcp-registry-cli.git
cd mcp-registry-cli

# Create virtual environment
python3 -m venv venv
source venv/bin/activate

# Install development dependencies
pip install -e ".[dev]"

Development Commands

# Run tests
pytest

# Format code
black src/

# Type checking
mypy src/

# Test CLI locally
python3 -m src.mcp_registry_cli.cli --help

Requirements

  • Python 3.8+
  • click >= 8.0.0
  • requests >= 2.25.0
  • rich >= 12.0.0
  • tabulate >= 0.9.0

License

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

License Summary

  • ✅ Free to use for commercial and non-commercial purposes
  • ✅ Modify and distribute as needed
  • ✅ Include in your own projects
  • ✅ Must include copyright notice

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

Author

Loreto Parisi - loretoparisi@gmail.com

Acknowledgments

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mcp_registry_cli-0.2.3.tar.gz (21.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mcp_registry_cli-0.2.3-py3-none-any.whl (26.0 kB view details)

Uploaded Python 3

File details

Details for the file mcp_registry_cli-0.2.3.tar.gz.

File metadata

  • Download URL: mcp_registry_cli-0.2.3.tar.gz
  • Upload date:
  • Size: 21.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.3

File hashes

Hashes for mcp_registry_cli-0.2.3.tar.gz
Algorithm Hash digest
SHA256 b1e1ab0f748285dbc4bb0e54da8a88a1a3a885a21feccf0a49ef847d6cb8355d
MD5 be0e7dc055889d4d7b6b148ec45bfac8
BLAKE2b-256 7e6caf328da12aac957f9bca56976462535f0eefd31debbbef1396163e951de9

See more details on using hashes here.

File details

Details for the file mcp_registry_cli-0.2.3-py3-none-any.whl.

File metadata

File hashes

Hashes for mcp_registry_cli-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 d2283999adcd63e89bb7660d3cc62bc7208d786d84a271f7706dd65888d963fa
MD5 d7b01f02f148e77d93238250a47c495c
BLAKE2b-256 155a5d52ad1098c01736037d34437b3b57748243609c6b6192d3f99c15f9b961

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page