README updates
Some checks failed
Build and Push Image / Build and push image (push) Has been cancelled

This commit is contained in:
armistace 2025-07-23 13:45:55 +10:00
parent 2b8cada173
commit f7506b4f20

View File

@ -1,11 +1,11 @@
# MCPO Project # MCPO Project
This repository contains the source code, configuration files, and deployment instructions for a project that uses Docker, Kubernetes, and the `mcpo` tool to manage mulitiple MCP (Multi-Component Protocol) service. This repository contains the source code, configuration files, and deployment instructions for a project that uses Docker, Kubernetes, and the `mcpo` tool to manage mulitiple MCP (Multi-Component Protocol) services.
## Overview ## Overview
The project sets up: The project sets up:
- A Docker container running the `mcpo` tool with configuration from `mcpo_config.json` - A Docker container running the `mcpo` tool with configuration from `mcpo_config.yaml` managed by config_builder.py
- A Kubernetes deployment for the Gitea MCP application - A Kubernetes deployment for the Gitea MCP application
- Services and pods to manage the application's networking and lifecycle - Services and pods to manage the application's networking and lifecycle
@ -22,10 +22,12 @@ The project sets up:
- **kube/service.yaml**: Service configuration to expose the application - **kube/service.yaml**: Service configuration to expose the application
### Configuration ### Configuration
- **mcpo_config.json**: Main configuration file for the `mcpo` tool, containing: ### Configuration
- MCP server settings
- Authentication credentials - **Configuration File**: Managed through `mcpo_config.yaml`.
- API endpoints - **Conversion Tool**: Uses `config_builder.py` to convert YAML to JSON.
- **Template Guidelines**: Assumes the yaml will follw the guideline template outlined in [the MCPo configuration guidelines](https://github.com/open-webui/mcpo). It doesn't perform validation so it won't fail until build if you fuck it up
## Purpose ## Purpose
@ -63,7 +65,8 @@ This project provides a complete environment to:
## Notes ## Notes
- The `mcpo` tool is used to manage MCP connections - The `mcpo` tool is used to manage MCP connections
- The configuration file contains sensitive information (access tokens, Bearer tokens) - Sensitive information should be parsed via environment variables to mcpo_config.yaml
- mcpo_config.yaml will parse env vars using the following syntaz `!ENV ${YOUR_VAR}`
- The project is designed for production deployment with Kubernetes orchestration - The project is designed for production deployment with Kubernetes orchestration
For detailed explanations of individual components, refer to their respective files in the repository. For detailed explanations of individual components, refer to their respective files in the repository.