Documentation •
Tools •
Quickstart •
Contact Us
# Arcade MCP Server Framework
**To learn more about Arcade.dev, check out our [documentation](https://docs.arcade.dev/home).**
**To learn more about the Arcade MCP Server Framework, check out our [Arcade MCP documentation](https://python.mcp.arcade.dev/)**
_Pst. hey, you, give us a star if you like it!_
### Quick Start: Create a New Server
The fastest way to get started is with the `arcade new` command, which creates a complete MCP server project:
```bash
# Install the CLI
uv pip install arcade-mcp
# Create a new server project
arcade new my_server
# Navigate to the project
cd my_server
```
This generates a complete project with:
- **server.py** - Main server file with MCPApp and example tools
- **pyproject.toml** - Dependencies and project configuration
- **.env.example** - Example `.env` file containing a secret required by one of the generated tools in `server.py`
The generated `server.py` includes proper command-line argument handling:
```python
#!/usr/bin/env python3
import sys
from typing import Annotated
from arcade_mcp_server import MCPApp
app = MCPApp(name="my_server", version="1.0.0")
@app.tool
def greet(name: Annotated[str, "Name to greet"]) -> str:
"""Greet someone by name."""
return f"Hello, {name}!"
if __name__ == "__main__":
transport = sys.argv[1] if len(sys.argv) > 1 else "http"
app.run(transport=transport, host="127.0.0.1", port=8000)
```
This approach gives you:
- **Complete Project Setup** - Everything you need in one command
- **Best Practices** - Proper dependency management with pyproject.toml
- **Example Code** - Learn from working examples of common patterns
- **Production Ready** - Structured for growth and deployment
### Running Your Server
Run your server directly with Python:
```bash
# Run with HTTP transport (default)
uv run server.py
# Run with stdio transport (for Claude Desktop)
uv run server.py stdio
# Or use python directly
python server.py http
python server.py stdio
```
Your server will start and listen for connections. With HTTP transport, you can access the API docs at http://127.0.0.1:8000/docs.
### Configure MCP Clients
Once your server is running, connect it to your favorite AI assistant:
```bash
# Configure Claude Desktop (configures for stdio)
arcade configure claude --from-local
# Configure Cursor (configures for http streamable)
arcade configure cursor --from-local
# Configure VS Code (configures for http streamable)
arcade configure vscode --from-local
```
## Client Libraries
- **[ArcadeAI/arcade-py](https://github.com/ArcadeAI/arcade-py):**
The Python client for interacting with Arcade.
- **[ArcadeAI/arcade-js](https://github.com/ArcadeAI/arcade-js):**
The JavaScript client for interacting with Arcade.
- **[ArcadeAI/arcade-go](https://github.com/ArcadeAI/arcade-go):**
The Go client for interacting with Arcade.
## Support and Community
- **Discord:** Join our [Discord community](https://discord.com/invite/GUZEMpEZ9p) for real-time support and discussions.
- **GitHub:** Contribute or report issues on the [Arcade GitHub repository](https://github.com/ArcadeAI/arcade-mcp).
- **Documentation:** Find in-depth guides and API references at [Arcade Documentation](https://docs.arcade.dev).