Skip to main content

Reliable microservice with unified JSON-RPC endpoint

Project description

MCP Proxy Adapter

MCP Proxy Adapter - это фреймворк для создания микросервисов на основе JSON-RPC. Он предоставляет базовую инфраструктуру для создания команд, обработки запросов и возвращения ответов через JSON-RPC API.

MCP Proxy Adapter - это фреймворк для создания микросервисов на основе JSON-RPC. Он предоставляет базовую инфраструктуру для создания команд, обработки запросов и возвращения ответов через JSON-RPC API.

Установка

pip install mcp-proxy-adapter

Использование

  1. Создайте свой проект и установите зависимость:
pip install mcp-proxy-adapter
  1. Создайте свои команды:
from mcp_proxy_adapter.commands.base import Command
from mcp_proxy_adapter.commands.result import SuccessResult

class YourCommand(Command):
    name = "your_command"
    
    async def execute(self, param1: str, param2: int = 0) -> SuccessResult:
        # Ваша логика
        result_data = {"param1": param1, "param2": param2}
        return SuccessResult(data=result_data)
  1. Запустите сервер:
import uvicorn
from mcp_proxy_adapter.api.app import create_app

# Регистрация ваших команд происходит автоматически
app = create_app()

uvicorn.run(app, host="0.0.0.0", port=8000)

Структура проекта

Проект представляет собой фреймворк с базовой инфраструктурой:

  • mcp_proxy_adapter/ - основной модуль фреймворка
    • api/ - модуль API
    • commands/ - базовые классы команд
    • core/ - ядро фреймворка
    • schemas/ - JSON-схемы
  • examples/ - примеры использования фреймворка
    • basic_example/ - базовый пример
    • minimal_example/ - минимальный пример
    • complete_example/ - полный пример с Docker

Базовые команды

Фреймворк включает следующие базовые команды:

  • help - получение справки по доступным командам
  • health - проверка состояния сервиса

API

Фреймворк предоставляет следующие эндпоинты:

  • POST /api/jsonrpc - основной JSON-RPC эндпоинт для выполнения команд
  • POST /api/command/{command_name} - REST эндпоинт для выполнения конкретной команды
  • GET /api/commands - получение списка доступных команд
  • GET /api/commands/{command_name} - получение информации о конкретной команде
  • GET /health - проверка состояния сервиса

Запуск примеров

# Базовый пример
cd examples/basic_example
python main.py

# Минимальный пример
cd examples/minimal_example
python main.py

# Полный пример с Docker
cd examples/complete_example
docker-compose up -d

Создание новой команды

Пример создания новой команды:

from typing import Dict, Any, ClassVar, Type
from mcp_proxy_adapter.commands.base import Command
from mcp_proxy_adapter.commands.result import SuccessResult

class CustomResult(SuccessResult):
    """
    Пользовательский класс результата.
    """
    
    def __init__(self, value: str):
        super().__init__(data={"value": value})
    
    @classmethod
    def get_schema(cls) -> Dict[str, Any]:
        return {
            "type": "object",
            "properties": {
                "data": {
                    "type": "object",
                    "properties": {
                        "value": {"type": "string"}
                    },
                    "required": ["value"]
                }
            },
            "required": ["data"]
        }

class CustomCommand(Command):
    """
    Пользовательская команда.
    """
    
    name: ClassVar[str] = "custom"
    result_class: ClassVar[Type[SuccessResult]] = CustomResult
    
    async def execute(self, input_text: str) -> CustomResult:
        return CustomResult(value=f"Processed: {input_text}")
    
    @classmethod
    def get_schema(cls) -> Dict[str, Any]:
        return {
            "type": "object",
            "properties": {
                "input_text": {"type": "string"}
            },
            "required": ["input_text"],
            "additionalProperties": False
        } 

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mcp_proxy_adapter-3.1.3.tar.gz (257.4 kB view details)

Uploaded Source

Built Distribution

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

mcp_proxy_adapter-3.1.3-py3-none-any.whl (144.8 kB view details)

Uploaded Python 3

File details

Details for the file mcp_proxy_adapter-3.1.3.tar.gz.

File metadata

  • Download URL: mcp_proxy_adapter-3.1.3.tar.gz
  • Upload date:
  • Size: 257.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for mcp_proxy_adapter-3.1.3.tar.gz
Algorithm Hash digest
SHA256 09822d9c83e35e7e93ed862468e3cfd99ed8b482a995f320d1beac6c79c5dec4
MD5 2e63ea60c7d1a95c6e752b3276b966b9
BLAKE2b-256 2ef514809f0d7fef6e78cbdef740777a3a9e519d8431b3ea7d6800ee559be836

See more details on using hashes here.

File details

Details for the file mcp_proxy_adapter-3.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for mcp_proxy_adapter-3.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a60d11c68a82a64fab2f9dd7358e79daf4441c1bc8a0470c91bdbcd49e8a088f
MD5 639e68a509129b43cb9c968e059f2697
BLAKE2b-256 0a52a7407cd86fa72cc1294ab561279aeee8f5d5ff2c84fb0aff203da4778802

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