VIZPILOT MCP Server

Access 1000+ development protocols and steering rules directly in your IDE

![License: MIT](https://opensource.org/licenses/MIT) ![Python 3.9+](https://www.python.org/downloads/)

</div>

🚀 Quick Start

Installation

# Install the package
pip install git+https://github.com/vizulabs-com/vizpilot-mcp.git

# View setup instructions
vizpilot-welcome

The vizpilot-welcome command displays:

✅ Installation confirmation
🔑 API key instructions
⚙️ IDE configuration examples
📚 Available MCP tools
🔗 Documentation links

Get Your API Key

Sign up at vizpilot.vizulabs.com
Navigate to Dashboard → API Keys
Generate a new API key

Configure Your IDE

Kiro IDE (~/.kiro/settings/mcp.json):

{
  "mcpServers": {
    "vizpilot": {
      "command": "python",
      "args": ["-m", "mcp_server.server"],
      "env": {
        "VIZPILOT_API_KEY": "your_api_key_here",
        "VIZPILOT_BASE_URL": "https://vizpilot.vizulabs.com"
      }
    }
  }
}

Cursor IDE (~/.cursor/mcp.json):

{
  "mcpServers": {
    "vizpilot": {
      "command": "python",
      "args": ["-m", "mcp_server.server"],
      "env": {
        "VIZPILOT_API_KEY": "your_api_key_here"
      }
    }
  }
}

See examples/ for more IDE configurations.

Restart Your IDE

After configuration, restart your IDE to activate the VIZPILOT MCP server.

📚 Features

1000+ Development Protocols - Django, React, Vue, Angular, Node.js, and more
Technology-Specific Steering Rules - Auto-injected guidance for your IDE
Real-time Protocol Search - Find protocols instantly across all technologies
Usage Tracking - Monitor API usage and subscription limits
Secure Authentication - API key-based access with rate limiting
Caching - Fast responses with intelligent caching

🛠️ Available MCP Tools

| Tool | Description | |------|-------------| | list_technologies | Browse all available technologies/frameworks | | list_protocols | View protocols for a specific technology | | get_protocol | Get full protocol content with markdown formatting | | get_steering_rules | Get IDE steering rules for auto-injection | | search_protocols | Search across all protocols by keyword | | get_user_info | Check subscription status, usage stats, and rate limits |

💡 Usage Examples

List Available Technologies

# Returns: Django, React, Vue, Angular, Node.js, Python, etc.
list_technologies(api_key="your_api_key")

Get Django Protocols

# Returns: All Django-related protocols
list_protocols(api_key="your_api_key", technology_slug="django")

Search for Authentication Protocols

# Returns: All protocols related to authentication
search_protocols(api_key="your_api_key", query="authentication")

🔄 Updates

pip install --upgrade git+https://github.com/vizulabs-com/vizpilot-mcp.git

🐛 Troubleshooting

Welcome Message Not Showing During Installation?

This is normal! Pip suppresses output from setup.py. Run this command to view setup instructions:

vizpilot-welcome

Can't Find vizpilot-welcome Command?

Make sure Python's bin directory is in your PATH:

# Check if it's installed
pip show vizpilot-mcp

# Try running directly
python -m mcp_server.__main__

MCP Server Not Connecting?

Verify your API key is correct
Check IDE configuration file location
Restart your IDE after configuration changes
Check IDE logs for error messages

📖 Documentation

🤝 Support

Issues: GitHub Issues
Email: support@vizulabs.com
Documentation: docs.vizpilot.vizulabs.com

📄 License

MIT License - see LICENSE file for details.

🌟 Show Your Support

If you find VIZPILOT MCP helpful:

⭐ Star this repository
🐦 Share on social media
📝 Write a review
🤝 Contribute to the project

---

Made with ❤️ by VizuLabs

Get Started • Documentation • Support