https://github.com/hiddenpath/spiderswitch
MCP server for dynamic AI model switching in the ai-lib ecosystem. MCP服务器,用于ai-lib生态系统动态AI模型切换。
https://github.com/hiddenpath/spiderswitch
Last synced: 3 months ago
JSON representation
MCP server for dynamic AI model switching in the ai-lib ecosystem. MCP服务器,用于ai-lib生态系统动态AI模型切换。
- Host: GitHub
- URL: https://github.com/hiddenpath/spiderswitch
- Owner: hiddenpath
- License: apache-2.0
- Created: 2026-02-28T22:14:40.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2026-03-02T09:54:27.000Z (4 months ago)
- Last Synced: 2026-03-02T12:27:12.569Z (4 months ago)
- Language: Python
- Size: 106 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# spiderswitch for ai-lib Ecosystem
[](https://www.python.org/downloads/)
[](LICENSE)
MCP (Model Context Protocol) server that enables agents to dynamically switch AI models from the [ai-lib ecosystem](https://github.com/hiddenpath/ai-lib-python).
## Features
- **Protocol-Driven**: All model configurations loaded from ai-protocol manifests (ARCH-001)
- **Multi-Provider Support**: Switch between OpenAI, Anthropic, Google, DeepSeek, and more
- **Runtime-Agnostic**: Uses ai-lib-python SDK for unified model interaction
- **MCP-Compliant**: Implements standard MCP tools over stdio transport
- **Capability Discovery**: Query available models and their capabilities
- **Runtime Profile Signal**: Exposes runtime capability profile for upper-layer routing policy engines
- **Local Readiness Hints**: `list_models` includes API key presence and proxy readiness per provider
- **Explicit Exit Path**: `exit_switcher` resets switcher runtime/state for clean fallback
- **Auto Protocol Setup**: Auto-detects local `ai-protocol` path and sets `AI_PROTOCOL_PATH` for current process
- **Official Dist Sync**: Best-effort sync of official `dist/v1/*.json` snapshot into local `ai-protocol/dist/v1`
## Quick Start
### Installation
```bash
# Clone the repository
git clone https://github.com/hiddenpath/spiderswitch.git
cd spiderswitch
# Install dependencies
pip install -e .
```
### Environment Setup
Set up your API keys:
```bash
export OPENAI_API_KEY="sk-..."
export ANTHROPIC_API_KEY="sk-ant-..."
export GOOGLE_API_KEY="..."
```
Recommended provider key mapping:
| Provider | Environment Variable |
|----------|----------------------|
| openai | `OPENAI_API_KEY` |
| anthropic | `ANTHROPIC_API_KEY` |
| google | `GOOGLE_API_KEY` or `GEMINI_API_KEY` |
| deepseek | `DEEPSEEK_API_KEY` |
| cohere | `COHERE_API_KEY` |
| mistral | `MISTRAL_API_KEY` |
Security note:
- Prefer environment variables over passing `api_key` in tool arguments.
- The server redacts sensitive fields in logs, but passing secrets in arguments still increases exposure risk in client traces.
Optional runtime env controls:
- `SPIDERSWITCH_SYNC_DIST=0` to disable startup sync of official `dist` json files.
- `AI_PROTOCOL_DIST_BASE_URL` to override raw dist source (default official GitHub raw URL).
- `AI_PROTOCOL_DIST_API_BASE_URL` to override GitHub API listing source for models/providers dist json.
### Configuration
Add to your MCP client configuration (e.g., Cursor, Claude Desktop):
```json
{
"mcpServers": {
"spiderswitch": {
"command": "python",
"args": ["-m", "spiderswitch.server"],
"env": {
"AI_PROTOCOL_PATH": "/path/to/ai-protocol"
}
}
}
}
```
### Usage
In your agent, call MCP tools:
```python
# List available models
models = await mcp_client.call_tool("list_models", {})
# Switch to Claude 3.5 Sonnet
await mcp_client.call_tool(
"switch_model",
{"model": "anthropic/claude-3-5-sonnet"}
)
# Check current status
status = await mcp_client.call_tool("get_status", {})
```
## Available MCP Tools
### 1. switch_model
Switches to a different AI model/provider.
**Parameters:**
- `model` (string, required): Model identifier (e.g., `openai/gpt-4o`, `anthropic/claude-3-5-sonnet`)
- `api_key` (string, optional): Explicit API key (overrides environment variable; not recommended for production)
- `base_url` (string, optional): Custom base URL for testing/mock
- `runtime_id` (string, optional): Runtime target selected by upper-layer policy
**Returns:**
```json
{
"status": "success",
"data": {
"id": "anthropic/claude-3-5-sonnet",
"provider": "anthropic",
"capabilities": ["streaming", "tools", "vision"],
"proxy_status": {
"provider": "anthropic",
"proxy_required_guess": false,
"proxy_configured": false,
"configured_proxy_env_vars": [],
"hint": null
},
"warnings": []
},
"message": "Successfully switched to anthropic/claude-3-5-sonnet"
}
```
### 2. list_models
Lists all available models from registered providers.
**Parameters:**
- `filter_provider` (string, optional): Filter by provider ID
- `filter_capability` (string, optional): Filter by capability (`streaming`, `tools`, `vision`, `embeddings`, `audio`)
- `runtime_id` (string, optional): Runtime target selected by upper-layer policy
**Returns:**
```json
{
"status": "success",
"data": {
"count": 2,
"runtime_profile": {
"runtime_id": "python-runtime",
"language": "python",
"supports": ["model_switching", "capability_filtering", "provider_manifest_loading"]
},
"models": [
{
"id": "openai/gpt-4o",
"provider": "openai",
"capabilities": ["streaming", "tools", "vision"],
"api_key_status": {
"provider": "openai",
"has_api_key": true,
"expected_env_vars": ["OPENAI_API_KEY"],
"configured_env_vars": ["OPENAI_API_KEY"]
},
"proxy_status": {
"provider": "openai",
"proxy_required_guess": true,
"proxy_configured": false,
"configured_proxy_env_vars": [],
"hint": "This provider may require proxy access in your network region. Set HTTPS_PROXY/HTTP_PROXY in the MCP server process environment if needed."
}
},
{
"id": "anthropic/claude-3-5-sonnet",
"provider": "anthropic",
"capabilities": ["streaming", "tools", "vision"]
}
],
"filtered": {
"require_api_key": false,
"provider": null,
"capability": null
}
}
}
```
### 3. get_status
Gets current model status and configuration.
**Parameters:**
- `runtime_id` (string, optional): Query status in a specific runtime scope
**Returns:**
```json
{
"status": "success",
"data": {
"provider": "anthropic",
"model": "claude-3-5-sonnet",
"capabilities": ["streaming", "tools", "vision"],
"runtime_profile": {
"runtime_id": "python-runtime",
"language": "python",
"supports": ["model_switching", "capability_filtering", "provider_manifest_loading"]
},
"is_configured": true,
"connection_epoch": 3,
"last_switched_at": "2026-03-02T09:00:00+00:00"
}
}
```
### 4. exit_switcher
Explicitly reset spiderswitch state and runtime client.
**Parameters:**
- `runtime_id` (string, optional): Runtime id for scoped reset
- `scope` (string, optional): `all` (default) or `runtime`
**Returns:**
```json
{
"status": "success",
"data": {
"exited": true,
"status": {
"provider": null,
"model": null,
"is_configured": false
}
}
}
```
## API Key Guidance and Troubleshooting
When `switch_model` fails due to missing credentials, the response includes:
- `provider`: which provider is missing credentials
- `expected_env_vars`: accepted environment variable names
- `hint`: actionable setup instruction
Typical setup flow:
1. Configure provider key in your MCP server process environment.
2. Restart the MCP server process if your client does not support hot env reload.
3. Call `switch_model`.
4. Verify with `get_status`.
## Connection Coordination with Agent Runtime
This MCP server manages model client lifecycle internally. To avoid conflicts with an agent's own connection manager:
- Treat MCP switcher as the control plane for model selection.
- Let the agent side observe `get_status.connection_epoch`.
- Rebuild agent-side cached sessions only when `connection_epoch` increases.
This pattern prevents stale session reuse after model switches and supports deterministic synchronization.
## Runtime Routing Boundary
spiderswitch only executes routing actions with explicit runtime signals:
- Runtime capability model is exposed via `runtime_profile` (runtime-neutral schema).
- Runtime selection policy remains in upper-layer applications.
- Built-in registry/resolver only resolves `runtime_id` and does not implement cost/quality/business strategy.
## Architecture
```
spiderswitch/
├── src/
│ ├── server.py # MCP server main entry point
│ ├── tools/ # MCP tool implementations
│ │ ├── switch.py # switch_model tool
│ │ ├── list.py # list_models tool
│ │ ├── status.py # get_status tool
│ │ └── reset.py # exit_switcher tool
│ ├── runtime/ # Runtime abstraction layer
│ │ ├── base.py # Base runtime interface
│ │ ├── python_runtime.py # ai-lib-python implementation
│ │ └── loader.py # ProtocolLoader wrapper
│ └── state.py # State management
├── tests/ # Test suite
└── pyproject.toml # Project configuration
```
## Development
### Running Tests
```bash
# Install test dependencies
pip install -e ".[dev]"
# Run tests
pytest
# Run with coverage
pytest --cov=src/spiderswitch
```
### Testing with Mock Server
Use [ai-protocol-mock](https://github.com/hiddenpath/ai-protocol-mock):
```bash
# Start mock server
docker-compose up -d ai-protocol-mock
# Run with mock
MOCK_HTTP_URL=http://localhost:4010 python -m spiderswitch.server
```
### Code Style
```bash
# Format code
ruff format src tests
# Lint
ruff check src tests
# Type check
mypy src
```
## Protocol-Driven Design (ARCH-001)
This server follows the ai-lib design principle:
> **一切逻辑皆算子,一切配置皆协议**
All provider configurations are loaded from ai-protocol manifests. No provider-specific logic is hardcoded. Adding a new provider requires only a manifest file in ai-protocol.
Routing boundary:
- spiderswitch exposes runtime/model capability signals only.
- Routing strategy policy (cost/latency/circuit-breaker/business rules) belongs to upper-layer applications.
Deterministic routing contract:
- runtime resolution order is fixed as `request runtime_id -> active state runtime_id -> default runtime`.
- reset supports scoped behavior (`scope=runtime`) to clear a target runtime without global teardown.
- contract tests in `tests/test_runtime.py` verify resolver order and scoped reset stability.
## Related Projects
- [ai-protocol](https://github.com/hiddenpath/ai-protocol) - Protocol specification
- [ai-lib-python](https://github.com/hiddenpath/ai-lib-python) - Python runtime SDK
- [ai-lib-rust](https://github.com/hiddenpath/ai-lib-rust) - Rust runtime SDK
- [ai-lib-ts](https://github.com/hiddenpath/ai-lib-ts) - TypeScript runtime SDK
## License
This project is licensed under either of:
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
- MIT License ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
at your option.
## Contributing
Contributions are welcome! Please ensure:
1. Code follows PEP 8 and passes `ruff check`
2. Type hints pass `mypy --strict`
3. Tests are included for new features
4. Documentation is updated
---
**spiderswitch** - Where MCP meets ai-lib. 🤖🔀