Skip to main content

A simple wrapper library for FastMCP + Starlette

Project description

README.md

viyv_mcp

viyv_mcp is a simple Python wrapper library for FastMCP and Starlette.
It enables you to quickly create a fully‐configured MCP server project with sample tools, resources, prompts, and external configuration support.

Features

  • Quick Project Creation:
    Use the provided CLI command create-viyv-mcp new <project_name> to generate a new project template with a complete directory structure and sample files.
  • Integrated MCP Server:
    Automatically sets up FastMCP with Starlette and provides an SSE-based API.
  • Decorator APIs:
    Simplify registration of tools, resources, prompts, and agents with built-in decorators (@tool, @resource, @prompt, and @agent).
  • External MCP Bridge Support:
    Automatically launches and registers external MCP servers based on JSON config files in app/mcp_server_configs.
  • Health Check Endpoint:
    Provides a /health endpoint to verify server status (returns {"status":"ok"}).
  • Template Inclusion:
    The generated project templates include:
    • Configuration Files: (e.g. app/config.py)
    • Prompts: (e.g. app/prompts/sample_prompt.py)
    • Resources: (e.g. app/resources/sample_echo_resource.py)
    • Tools: (e.g. app/tools/sample_math_tools.py)
    • MCP Server Configs: (e.g. app/mcp_server_configs/sample_slack.json)
    • Dockerfile, pyproject.toml, and main.py for the generated project.

Installation

From PyPI

Install viyv_mcp via pip:

pip install viyv_mcp

This installs the package as well as provides the CLI command create-viyv-mcp.

Usage

Creating a New Project Template

After installing the package, run:

create-viyv-mcp new my_mcp_project

This command creates a new directory called my_mcp_project with the following structure:

my_mcp_project/
├── Dockerfile
├── pyproject.toml
├── main.py
└── app/
    ├── config.py
    ├── mcp_server_configs/
    │   └── sample_slack.json
    ├── prompts/
    │   └── sample_prompt.py
    ├── resources/
    │   └── sample_echo_resource.py
    └── tools/
        └── sample_math_tools.py

Running the MCP Server

  1. Change into your new project directory:

    cd my_mcp_project
    
  2. Use uv to resolve dependencies (this uses the pyproject.toml for dependency management):

    uv sync
    
  3. Start the server with:

    uv run python main.py
    

The server will start on 0.0.0.0:8000 by default. It exposes an SSE-based API at / and /messages, provides a health-check endpoint at /health (returns {"status":"ok"}), automatically registers local modules (tools, resources, prompts), and bridges external MCP servers defined in app/mcp_server_configs.

Package Structure

viyv_mcp/
├── __init__.py           # Exports version, ViyvMCP, and decorators
├── core.py               # FastMCP integration and ASGI app setup
├── cli.py                # CLI command (create-viyv-mcp)
├── decorators.py         # Decorators for tool, resource, prompt, and agent registration
├── app/
│   ├── config.py         # Configuration (HOST, PORT, BRIDGE_CONFIG_DIR)
│   ├── lifespan.py       # Lifecycle context manager
│   ├── registry.py       # Module auto-registration logic
│   └── bridge_manager.py # External bridge management (init and close)
└── templates/
    ├── Dockerfile
    ├── pyproject.toml
    ├── main.py
    └── app/              # Sample project scaffold
        ├── config.py
        ├── mcp_server_configs/sample_slack.json
        ├── prompts/sample_prompt.py
        ├── resources/sample_echo_resource.py
        └── tools/sample_math_tools.py

pyproject.toml
README.md

Contributing

Contributions are welcome! If you find a bug or have a feature request, please open an issue or create a pull request on GitHub.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contact

For any inquiries, please contact:

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

viyv_mcp-0.1.2.tar.gz (28.7 kB view details)

Uploaded Source

Built Distribution

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

viyv_mcp-0.1.2-py3-none-any.whl (38.6 kB view details)

Uploaded Python 3

File details

Details for the file viyv_mcp-0.1.2.tar.gz.

File metadata

  • Download URL: viyv_mcp-0.1.2.tar.gz
  • Upload date:
  • Size: 28.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.7

File hashes

Hashes for viyv_mcp-0.1.2.tar.gz
Algorithm Hash digest
SHA256 62bbdeab3a41c1fc527167a1f8ad237260b4a722f72446fa6c93998e1bccedc2
MD5 c6b0ab56c4389f85095464ce9d5fdfd0
BLAKE2b-256 c5d48488e9d7c3f40b1c1d327dda6805ff741206e336bea49228949381bf9a44

See more details on using hashes here.

File details

Details for the file viyv_mcp-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: viyv_mcp-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 38.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.7

File hashes

Hashes for viyv_mcp-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 df61f1af40893ab610ee86b9bee645f87a1401fb4cf3b4ad23381e4a9c804aed
MD5 c186f7907f00edf21667e2a82eeb5fd5
BLAKE2b-256 fb0bed30322cd9e1a77e1f6d775b858233367f43de30cb3908fcfeacc297ad2b

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