docs: add references to individual server documentation files
- Add documentation links in main README overview section - Create new Documentation section listing all README files - Ensure all README files are properly referenced - All server documentation is now easily discoverable 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
parent
320777fd3a
commit
f9d8407c09
26
README.md
26
README.md
@ -6,13 +6,13 @@ A comprehensive collection of Model Context Protocol (MCP) servers for managing
|
||||
|
||||
The Portainer MCP Server Suite consists of specialized servers that work together to provide complete Portainer management capabilities:
|
||||
|
||||
- **[portainer-core](./portainer_core_server.py)** - Authentication, user management, teams, and RBAC
|
||||
- **[portainer-environments](./portainer_environments_server.py)** - Environment and endpoint management
|
||||
- **[portainer-docker](./portainer_docker_server.py)** - Docker container and image operations
|
||||
- **[portainer-kubernetes](./portainer_kubernetes_server.py)** - Kubernetes cluster management
|
||||
- **[portainer-stacks](./portainer_stacks_server.py)** - Stack deployment and management
|
||||
- **[portainer-edge](./portainer_edge_server.py)** - Edge computing and device management
|
||||
- **[portainer-gitops](./portainer_gitops_server.py)** - GitOps automation and deployments
|
||||
- **[portainer-core](./portainer_core_server.py)** - Authentication, user management, teams, and RBAC ([Documentation](./README_CORE.md))
|
||||
- **[portainer-environments](./portainer_environments_server.py)** - Environment and endpoint management ([Documentation](./README_ENVIRONMENTS.md))
|
||||
- **[portainer-docker](./portainer_docker_server.py)** - Docker container and image operations ([Documentation](./README_DOCKER.md))
|
||||
- **[portainer-kubernetes](./portainer_kubernetes_server.py)** - Kubernetes cluster management ([Documentation](./README_KUBERNETES.md))
|
||||
- **[portainer-stacks](./portainer_stacks_server.py)** - Stack deployment and management ([Documentation](./README_STACKS.md))
|
||||
- **[portainer-edge](./portainer_edge_server.py)** - Edge computing and device management ([Documentation](./README_EDGE.md))
|
||||
- **[portainer-gitops](./portainer_gitops_server.py)** - GitOps automation and deployments ([Documentation](./README_GITOPS.md))
|
||||
|
||||
## Features
|
||||
|
||||
@ -244,6 +244,18 @@ Currently, manual testing is recommended:
|
||||
3. Verify responses match expected behavior
|
||||
4. Test error conditions
|
||||
|
||||
## Documentation
|
||||
|
||||
Each server has its own detailed documentation:
|
||||
|
||||
- **[Core Server Documentation](./README_CORE.md)** - User management, teams, RBAC, and settings
|
||||
- **[Environments Server Documentation](./README_ENVIRONMENTS.md)** - Environment and endpoint management
|
||||
- **[Docker Server Documentation](./README_DOCKER.md)** - Container, image, volume, and network operations
|
||||
- **[Kubernetes Server Documentation](./README_KUBERNETES.md)** - Kubernetes cluster and resource management
|
||||
- **[Stacks Server Documentation](./README_STACKS.md)** - Stack deployment and lifecycle management
|
||||
- **[Edge Server Documentation](./README_EDGE.md)** - Edge device and edge compute management
|
||||
- **[GitOps Server Documentation](./README_GITOPS.md)** - GitOps automation and continuous deployment
|
||||
|
||||
## Contributing
|
||||
|
||||
1. Fork the repository
|
||||
|
@ -44,17 +44,18 @@ This MCP server provides core Portainer functionality by combining user manageme
|
||||
|
||||
1. Install Python dependencies:
|
||||
```bash
|
||||
cd /Users/adelorenzo/repos/portainer-mcp
|
||||
.venv/bin/pip install mcp httpx
|
||||
pip install mcp httpx aiohttp
|
||||
# Or use the requirements file:
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
2. Configure in Claude Desktop (`claude_desktop_config.json`):
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"portainer": {
|
||||
"command": "/path/to/.venv/bin/python",
|
||||
"args": ["/path/to/portainer_core_server.py"],
|
||||
"portainer-core": {
|
||||
"command": "python",
|
||||
"args": ["/path/to/portainer-mcp/portainer_core_server.py"],
|
||||
"env": {
|
||||
"PORTAINER_URL": "https://your-portainer-instance.com",
|
||||
"PORTAINER_API_KEY": "your-api-key",
|
||||
|
@ -62,8 +62,9 @@ This MCP server provides comprehensive Docker and Docker Swarm management functi
|
||||
|
||||
1. Ensure Python dependencies are installed:
|
||||
```bash
|
||||
cd /Users/adelorenzo/repos/portainer-mcp
|
||||
.venv/bin/pip install mcp httpx
|
||||
pip install mcp httpx aiohttp
|
||||
# Or use the requirements file:
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
2. Configure in Claude Desktop (`claude_desktop_config.json`):
|
||||
@ -71,8 +72,8 @@ cd /Users/adelorenzo/repos/portainer-mcp
|
||||
{
|
||||
"mcpServers": {
|
||||
"portainer-docker": {
|
||||
"command": "/path/to/.venv/bin/python",
|
||||
"args": ["/path/to/portainer_docker_server.py"],
|
||||
"command": "python",
|
||||
"args": ["/path/to/portainer-mcp/portainer_docker_server.py"],
|
||||
"env": {
|
||||
"PORTAINER_URL": "https://your-portainer-instance.com",
|
||||
"PORTAINER_API_KEY": "your-api-key",
|
||||
|
@ -20,6 +20,8 @@ This MCP server provides edge computing functionality through Portainer's API, m
|
||||
|
||||
2. Install dependencies:
|
||||
```bash
|
||||
pip install mcp httpx aiohttp
|
||||
# Or use the requirements file:
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
|
@ -51,8 +51,9 @@ This MCP server provides comprehensive environment and endpoint management funct
|
||||
|
||||
1. Ensure Python dependencies are installed:
|
||||
```bash
|
||||
cd /Users/adelorenzo/repos/portainer-mcp
|
||||
.venv/bin/pip install mcp httpx
|
||||
pip install mcp httpx aiohttp
|
||||
# Or use the requirements file:
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
2. Configure in Claude Desktop (`claude_desktop_config.json`):
|
||||
@ -60,8 +61,8 @@ cd /Users/adelorenzo/repos/portainer-mcp
|
||||
{
|
||||
"mcpServers": {
|
||||
"portainer-environments": {
|
||||
"command": "/path/to/.venv/bin/python",
|
||||
"args": ["/path/to/portainer_environments_server.py"],
|
||||
"command": "python",
|
||||
"args": ["/path/to/portainer-mcp/portainer_environments_server.py"],
|
||||
"env": {
|
||||
"PORTAINER_URL": "https://your-portainer-instance.com",
|
||||
"PORTAINER_API_KEY": "your-api-key",
|
||||
|
@ -218,6 +218,8 @@ The complete `autoUpdate` object structure:
|
||||
|
||||
2. Install dependencies:
|
||||
```bash
|
||||
pip install mcp httpx aiohttp
|
||||
# Or use the requirements file:
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
|
@ -23,6 +23,8 @@ This MCP server provides comprehensive Kubernetes cluster management capabilitie
|
||||
|
||||
2. Install dependencies:
|
||||
```bash
|
||||
pip install mcp httpx aiohttp
|
||||
# Or use the requirements file:
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
|
@ -22,6 +22,8 @@ This MCP server provides comprehensive stack deployment and management capabilit
|
||||
|
||||
2. Install dependencies:
|
||||
```bash
|
||||
pip install mcp httpx aiohttp
|
||||
# Or use the requirements file:
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user