arcade-mcp

<h3 align="center"> <a name="readme-top"></a> <img src="https://docs.arcade.dev/images/logo/arcade-logo.png" style="width: 400px;" > </h3> <div align="center"> <a href="https://github.com/arcadeai/arcade-mcp/blob/main/LICENSE"> <img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License"> </a> <img src="https://img.shields.io/github/last-commit/ArcadeAI/arcade-mcp" alt="GitHub last commit"> <a href="https://github.com/arcadeai/arcade-mcp/actions?query=branch%3Amain"> <img src="https://img.shields.io/github/actions/workflow/status/arcadeai/arcade-mcp/main.yml?branch=main" alt="GitHub Actions Status"> </a> <a href="https://img.shields.io/pypi/pyversions/arcade-mcp"> <img src="https://img.shields.io/pypi/pyversions/arcade-mcp" alt="Python Version"> </a> </div> <div> <p align="center" style="display: flex; justify-content: center; gap: 10px;"> <a href="https://x.com/TryArcade"> <img src="https://img.shields.io/badge/Follow%20on%20X-000000?style=for-the-badge&logo=x&logoColor=white" alt="Follow on X" style="width: 125px;height: 25px; padding-top: .8px; border-radius: 5px;" /> </a> <a href="https://www.linkedin.com/company/arcade-mcp" > <img src="https://img.shields.io/badge/Follow%20on%20LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white" alt="Follow on LinkedIn" style="width: 150px; padding-top: 1.5px;height: 22px; border-radius: 5px;" /> </a> <a href="https://discord.com/invite/GUZEMpEZ9p"> <img src="https://img.shields.io/badge/Join%20our%20Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white" alt="Join our Discord" style="width: 150px; padding-top: 1.5px; height: 22px; border-radius: 5px;" /> </a> </p> </div> <p align="center" style="display: flex; justify-content: center; gap: 5px; font-size: 15px;"> <a href="https://docs.arcade.dev/tools" target="_blank">Prebuilt Tools</a> • <a href="https://docs.arcade.dev/home/contact-us" target="_blank">Contact Us</a> # Arcade MCP Server Framework * **To see example servers built with Arcade MCP Server Framework (this repo), check out our [examples](examples/)** * **To learn more about the Arcade MCP Server Framework (this repo), check out our [Arcade MCP documentation](https://docs.arcade.dev/en/home/build-tools/create-a-mcp-server)** * **To learn more about other offerings from Arcade.dev, check out our [documentation](https://docs.arcade.dev/home).** _Pst. hey, you, give us a star if you like it!_ <a href="https://github.com/ArcadeAI/arcade-mcp"> <img src="https://img.shields.io/github/stars/ArcadeAI/arcade-mcp.svg" alt="GitHub stars"> </a> ## Quick Start: Create a New Server The fastest way to get started is with the `arcade new` CLI command, which creates a complete MCP server project: ```bash # Install the CLI uv tool install arcade-mcp # Create a new server project arcade new my_server # Navigate to the project cd my_server/src/my_server ``` This generates a 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 and three example tools: ```python #!/usr/bin/env python3 """simple_server MCP server""" import sys from typing import Annotated import httpx from arcade_mcp_server import Context, MCPApp from arcade_mcp_server.auth import Reddit app = MCPApp(name="simple_server", version="1.0.0", log_level="DEBUG") @app.tool def greet(name: Annotated[str, "The name of the person to greet"]) -> str: """Greet a person by name.""" return f"Hello, {name}!" # To use this tool locally, you need to either set the secret in the .env file or as an environment variable @app.tool(requires_secrets=["MY_SECRET_KEY"]) def whisper_secret(context: Context) -> Annotated[str, "The last 4 characters of the secret"]: """Reveal the last 4 characters of a secret""" # Secrets are injected into the context at runtime. # LLMs and MCP clients cannot see or access your secrets # You can define secrets in a .env file. try: secret = context.get_secret("MY_SECRET_KEY") except Exception as e: return str(e) return "The last 4 characters of the secret are: " + secret[-4:] # To use this tool locally, you need to install the Arcade CLI (uv tool install arcade-mcp) # and then run 'arcade login' to authenticate. @app.tool(requires_auth=Reddit(scopes=["read"])) async def get_posts_in_subreddit( context: Context, subreddit: Annotated[str, "The name of the subreddit"] ) -> dict: """Get posts from a specific subreddit""" # Normalize the subreddit name subreddit = subreddit.lower().replace("r/", "").replace(" ", "") # Prepare the httpx request # OAuth token is injected into the context at runtime. # LLMs and MCP clien