viyv-mcp 0.1.0

A simple wrapper library for FastMCP + Starlette

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 includes auto-registration of local tools, resources, and prompts.

• Template Inclusion:
  The generated project contains pre-configured templates for:

  • Configuration Files: (e.g. app/config_files/sample_slack.json)
  • 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)
  • Additionally, a sample Dockerfile and pyproject.toml for the generated project are included.

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
    ├── config_files/
    │   └── 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. The project is pre-configured to automatically register local modules (tools, resources, prompts) and to attempt bridging any external MCP servers as specified in app/config_files/sample_slack.json.

Project Structure

• viyv_mcp/
  Contains the core Python package:
  • __init__.py: Re-exports key classes such as ViyvMCP.
  • core.py: Implements the ViyvMCP class that wraps FastMCP and integrates auto-registration, external bridge support, and Starlette integration.
  • cli.py: Implements the CLI entry point (create-viyv-mcp command).
  • templates/: Contains the project template files, including:
    • Dockerfile: For containerizing the generated project.
    • pyproject.toml: For dependency management of the generated project.
    • main.py: Entry point to launch the MCP server.
    • app/: Contains the sample application code:
      • config.py: Basic configuration (e.g., host, port, bridge config directory).
      • config_files/sample_slack.json: Sample external MCP server configuration.
      • prompts/sample_prompt.py: A sample prompt module.
      • resources/sample_echo_resource.py: A sample resource module.
      • tools/sample_math_tools.py: A sample tool module.

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:

• hiroki takezawa
  Email: [e-mail]
• GitHub: BrainFiber/viyv_mcp