Metadata-Version: 2.4
Name: mcp-modelservice-sdk
Version: 0.2.6
Summary: A CLI for the MCP Modelservice Example
Author: Haotian Liu @heywhale
License: MIT
Project-URL: Homepage, https://github.com/liuhaotian9420/mcp
Project-URL: Repository, https://github.com/liuhaotian9420/mcp
Project-URL: Documentation, https://github.com/liuhaotian9420/mcp/docs
Project-URL: Bug Tracker, https://github.com/liuhaotian9420/mcp/issues
Keywords: mcp,model-context-protocol,fastapi,cli,fastmcp
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
Classifier: Topic :: System :: Networking
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: mcp[cli]>=1.3.0
Requires-Dist: fastapi>=0.110.0
Requires-Dist: fastapi-mcp<=0.3.4
Requires-Dist: pydantic>=2.0.0
Requires-Dist: requests>=2.25.0
Requires-Dist: typer>=0.9.0
Requires-Dist: uvicorn>=0.20.0
Requires-Dist: python-dotenv>=0.15.0
Requires-Dist: fastmcp>=2.2.0
Provides-Extra: test
Requires-Dist: ruff>=0.9.10; extra == "test"
Requires-Dist: mypy>=1.0.0; extra == "test"
Requires-Dist: build>=1.0.0; extra == "test"
Requires-Dist: twine>=4.0.0; extra == "test"

# mcp-modelservice-sdk

🚀 **Easily build and deploy MCP (Model Context Protocol) services from your Python functions**

[![PyPI version](https://badge.fury.io/py/mcp-modelservice-sdk.svg)](https://badge.fury.io/py/mcp-modelservice-sdk)
[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/release/python-3100/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

`mcp-modelservice-sdk` is a powerful toolkit that transforms your Python functions into fully-featured MCP services with minimal configuration. Perfect for developers who want to quickly expose their Python code as MCP tools without the complexity of manual service setup.

## ✨ Key Features

- 📦 **Zero-Config Packaging**: Convert Python functions to MCP services instantly
- 🚀 **One-Command Deployment**: Start services with a single command
- 🔄 **Smart Auto-Routing**: Automatic endpoint generation based on your code structure
- 🌐 **Production Ready**: Built-in support for Docker, cloud platforms, and scaling
- 🛠️ **Developer Friendly**: Interactive testing interface and comprehensive documentation
- 🎯 **Type Safe**: Full support for Python type hints and automatic validation

## 🚀 Quick Start

### Installation

```bash
# Using pip
pip install mcp-modelservice-sdk

# Using uv (recommended)
pip install uv
uv pip install mcp-modelservice-sdk
```

### Basic Usage

1. **Create your Python functions**:
```python
# my_tools.py
def add_numbers(a: float, b: float) -> float:
    """Add two numbers together"""
    return a + b

def get_weather(city: str) -> str:
    """Get weather information for a city"""
    return f"Weather in {city}: Sunny, 25°C"
```

2. **Run as MCP service**:
```bash
# Start local development server
mcp-modelservice run --source-path my_tools.py --port 8080

# Or with uv
uvx mcp-modelservice-sdk run --source-path my_tools.py --port 8080
```

3. **Test your service**:
   - Visit `http://localhost:8080/mcp` for interactive testing
   - Use any MCP client to connect and call your functions

### Production Packaging

```bash
# Package for deployment
mcp-modelservice package --source-path ./my_code --output my-service.zip

# Extract and deploy
unzip my-service.zip
cd my-service/project
python main.py
```

## 🏗️ How It Works

The SDK automatically:
- **Discovers** all functions in your Python files
- **Converts** them to MCP-compatible tools with proper schemas
- **Generates** REST endpoints and documentation
- **Packages** everything into deployable services
- **Provides** interactive testing interfaces

### Architecture Modes

- **Composed Mode**: All tools accessible from a single endpoint
- **Routed Mode**: Directory-based routing with separate endpoints per module

## 🌐 Deployment Options

Deploy anywhere Python runs:
- **Local Development**: Direct execution with `python main.py`
- **Docker**: Pre-configured Dockerfile included
- **Cloud Platforms**: Compatible with Heroku, AWS Lambda, Google Cloud Run, Azure
- **Traditional Servers**: Standard WSGI/ASGI deployment

## 📚 Client Integration

### Python Client Example
```python
import requests

def call_tool(tool_name, params):
    response = requests.post(
        "http://localhost:8080/mcp",
        json={
            "jsonrpc": "2.0",
            "method": tool_name,
            "params": params,
            "id": 1
        }
    )
    return response.json()

# Use your functions
result = call_tool("add_numbers", {"a": 5, "b": 3})
print(result)  # {"jsonrpc": "2.0", "result": 8, "id": 1}
```

### FastMCP Client Example
```python
from fastmcp import FastMCP

client = FastMCP("http://localhost:8080")
result = await client.call_tool("add_numbers", {"a": 5, "b": 3})
```

## ⚙️ Configuration

### Command Line Options

| Option | Description | Default |
|--------|-------------|---------|
| `--source-path` | Path to Python files/directory | Current directory |
| `--port` | Service port | 8080 |
| `--host` | Service host | 127.0.0.1 |
| `--mcp-name` | Service name | Auto-generated |

### Environment Variables
```bash
# .env file
HOST=0.0.0.0
PORT=8080
MCP_SERVER_NAME=my-service
LOG_LEVEL=INFO
```

## 🤝 Use Cases

Perfect for:
- **Rapid Prototyping**: Quickly expose Python functions as web services
- **Microservices**: Convert existing Python modules to independent services
- **API Generation**: Auto-generate REST APIs from Python functions
- **Tool Integration**: Make Python tools accessible to MCP clients
- **Development Testing**: Interactive testing of Python functions

## 🛠️ Requirements

- **Python**: 3.10 or higher
- **Dependencies**: FastAPI, FastMCP, Pydantic, Uvicorn (auto-installed)

## 📖 Documentation & Support

- **GitHub Repository**: [https://github.com/modelcontextprotocol/mcp-modelservice-sdk](https://github.com/modelcontextprotocol/mcp-modelservice-sdk)
- **Full Documentation**: Available in the GitHub repository
- **Issue Tracking**: Report bugs and request features on GitHub
- **Community**: Join discussions and get help

## 🤝 Contributing

We welcome contributions! Please see our [Contributing Guide](https://github.com/modelcontextprotocol/mcp-modelservice-sdk/blob/main/CONTRIBUTING.md) for details.

## 📄 License

This project is licensed under the MIT License - see the [LICENSE](https://github.com/modelcontextprotocol/mcp-modelservice-sdk/blob/main/LICENSE) file for details.

---

**Made with ❤️ for the Python and MCP communities**

Ready to transform your Python functions into powerful MCP services? Install `mcp-modelservice-sdk` today! 
