Skip to main content

Flask integration for Model Context Protocol (MCP)

Project description

Flask-MCP

Flask integration for Model Context Protocol (MCP) - a framework for building MCP servers with Flask.

License: apache-2-0 Python Version Flask

Overview

Flask-MCP provides a simple and intuitive way to create Model Context Protocol (MCP) servers using Flask. It allows developers to easily expose tools, resources, and prompts that can be consumed by MCP clients, facilitating rich interactions between language models and external systems.

Features

  • Easy Integration: Seamless integration with Flask applications
  • Type Safety: Built-in support for type hints and Pydantic validation
  • Tool Support: Define MCP tools with automatic schema generation
  • Resource Management: Handle static and dynamic resources with URI templates
  • Prompt Generation: Create dynamic prompts for AI models
  • JSON Schema Generation: Automatic generation of JSON schemas from Python functions
  • Streaming Support: Streamable HTTP responses for large data

Installation

pip install flask-mcp-core

Quick Start

Here's a basic example to get you started:

from flask import Flask
from flask_mcp import MCP

app = Flask(__name__)
mcp = MCP()
mcp.init_app(app, "my_mcp_server", __name__)


# Define a simple tool
@mcp.tool
def add(a: int, b: int) -> int:
    """Add two numbers together."""
    return a + b


# Define a resource
@mcp.resource("http://example.com/data.json")
def get_data():
    """Return some static data."""
    return {"message": "Hello, MCP!"}


# Define a prompt
@mcp.prompt
def greeting(name: str) -> str:
    """Create a personalized greeting."""
    return f"Hello, {name}!"


if __name__ == "__main__":
    app.run(debug=True)

Core Concepts

Tools

Tools are functions that can be called by MCP clients. They can accept parameters and return structured results.

from flask_mcp import Text, Field
from typing import Annotated


@mcp.tool(
    name="calculate_sum",
    title="Calculate Sum",
    description="Add two floating point numbers",
    icons=[
        {
            "src": "https://example.com/calculator-icon.png",
            "mimeType": "image/png",
            "sizes": ["48x48"]
        }
    ]
)
def add_float(a: Annotated[float, Field(description="The first number")],
              b: Annotated[float, Field(description="The second number")]) -> Text:
    return Text(text=str(a + b))

Resources

Resources provide data that can be fetched by URI. Flask-MCP supports both static URIs and dynamic URI templates with parameters.

@mcp.resource("file://data/config.json")
def get_config():
    """Return static configuration data."""
    return {"setting1": "value1", "setting2": "value2"}


# Dynamic resource with path parameters
@mcp.resource("file://data/users/{user_id}.json")
def get_user(user_id: str):
    """Return user data by ID."""
    return {"id": user_id, "name": f"User {user_id}"}

Prompts

Prompts are specialized functions that return structured content to guide AI models.

from flask_mcp import Message, Text


@mcp.prompt
def daily_fact() -> Message:
    """Return a daily fact as a message."""
    return Message(
        content=Text(text="The capital of France is Paris.")
    )

Advanced Usage

Custom Output Schema

For tools that return structured data, you can specify a custom JSON schema:

@mcp.tool(
    output_schema={
        "type": "object",
        "properties": {
            "result": {"type": "string"},
            "success": {"type": "boolean"}
        },
        "required": ["result", "success"]
    }
)
def api_call():
    return {
        "result": "Operation completed successfully",
        "success": True
    }

Multiple Content Types

Tools can return multiple content types in a single response:

from flask_mcp import Image, Text


@mcp.tool
def multi_data():
    return [
        Image(data=base64_image_data),
        Text(text="Here's an image and some text")
    ]

Running the Examples

The repository includes comprehensive examples in the src/example/ directory:

  • tools.py - Examples of various tool definitions
  • resources.py - Examples of resource handling
  • prompt.py - Examples of prompt creation

To run an example:

cd src/example
python tools.py

Configuration

The MCP server can be configured with various options:

mcp = MCP()
mcp.init_app(
    app,
    name="my-awesome-server",
    import_name=__name__,
    url_prefix="/mcp",  # Endpoint prefix for MCP routes
    version="1.0.0"
)

API Endpoints

Once configured, Flask-MCP automatically creates the following endpoints:

  • POST /mcp - Main MCP JSON-RPC endpoint
  • GET /mcp/health - Health check endpoint

Development

Prerequisites

  • Python 3.9+
  • Flask 3+
  • Pydantic 2+

Setup

# Clone the repository
git clone https://github.com/flask-mcp/flask-mcp.git
cd flask-mcp

# Install dependencies
uv sync

License

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

Related Projects

Support

If you encounter any issues or have questions, please file an issue on the GitHub repository.

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

flask_mcp_core-0.1.0.tar.gz (16.4 kB view details)

Uploaded Source

Built Distribution

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

flask_mcp_core-0.1.0-py3-none-any.whl (18.2 kB view details)

Uploaded Python 3

File details

Details for the file flask_mcp_core-0.1.0.tar.gz.

File metadata

  • Download URL: flask_mcp_core-0.1.0.tar.gz
  • Upload date:
  • Size: 16.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.22

File hashes

Hashes for flask_mcp_core-0.1.0.tar.gz
Algorithm Hash digest
SHA256 debfff1b3b998be2f56b6465954565f713e1984c1058e84d8803f8280638660e
MD5 3dcac17623946484503774d0ee4ca441
BLAKE2b-256 a329e45de9997ab09aafd2da10cc131abfb7172e82894bcb248867c02f521dd1

See more details on using hashes here.

File details

Details for the file flask_mcp_core-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: flask_mcp_core-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 18.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.22

File hashes

Hashes for flask_mcp_core-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bb38390b11edf2d9c4ebfd190fe23c99e6ff77f06592cac22513a9035dee58a2
MD5 af18b04b31738638991fb28280882661
BLAKE2b-256 583fc49186a832a49ce39869e8c7063ba7390737875b23f82ed626490d6eb91a

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