Python Openstackmcp Server

1# python-openstackmcp-server
2 
3Openstack mcp server is a [Model Context Protocol (MCP)](https://modelcontextprotocol.io/docs/getting-started/intro) server that provides an interface for AI assistants to interact with OpenStack services.
4 
5```mermaid
6flowchart LR
7    AI[AI Assistant] <-->|MCP Protocol| Server[OpenStack MCP Server]
8    Server <-->|OpenStack SDK| SDK[OpenStack SDK]
9    SDK <-->|REST API| Cloud[OpenStack Cloud]
10```
11 
12# Table of Contents
13- [Table of Contents](#table-of-contents)
14- [Features](#features)
15- [Quick Start with Claude Desktop](#quick-start-with-claude-desktop)
16  - [Requirements](#requirements)
17  - [Using python](#using-python)
18  - [Using uvx](#using-uvx)
19  - [Contributing](#contributing)
20  - [License](#license)
21 
22# Features
23- **MCP Protocol Support**: Implements the Model Context Protocol for AI assistants.
24- **Compute Tools**: Manage OpenStack compute resources (servers, flavors).
25- **Image Tools**: Manage OpenStack images.
26- **Identity Tools**: Handle OpenStack identity and authentication.
27- **Network Tools**: Manage OpenStack networking resources.
28- **Block Storage Tools**: Manage OpenStack block storage resources.
29 
30# Quick Start with Claude Desktop
31 
32Get started quickly with the OpenStack MCP server using Claude Desktop
33 
34## Requirements
35- Python 3.10 or higher
36- OpenStack credentials configured in `clouds.yaml` file
37- Claude Desktop installed
38 
391. **Create or update your `clouds.yaml` file with your OpenStack credentials.**
40   
41   Example `clouds.yaml`:
42   ```yaml
43   clouds:
44     openstack:
45       auth:
46         auth_url: https://your-openstack-auth-url.com
47         username: your-username
48         password: your-password
49         project_name: your-project-name
50         user_domain_name: Default
51         project_domain_name: Default
52       region_name: your-region
53       interface: public
54       identity_api_version: 3
55   ```
56 
572. **Create or update your Claude Desktop configuration file**:
58   - **macOS**: Edit `$HOME/Library/Application Support/Claude/claude_desktop_config.json`
59   - **Windows**: Edit `%APPDATA%\Claude\claude_desktop_config.json`
60   - **Linux**: Edit `$HOME/.config/Claude/claude_desktop_config.json`
61   
62### Using python
63 
64   ```json
65   {
66     "mcpServers": {
67       "openstack-mcp-server": {
68         "command": "/path/to/your/python",
69         "args": [
70           "python-openstackmcp-server"
71         ],
72         "env" : {
73           "OS_CLIENT_CONFIG_FILE": "/path/to/your/clouds.yaml"
74         }
75       }
76     }
77   }
78   ```
79 
80### Using uvx
81  
82   ```json
83   {
84     "mcpServers": {
85       "openstack-mcp-server": {
86         "command": "uvx",
87         "args": [
88           "python-openstackmcp-server"
89         ],
90         "env" : {
91           "OS_CLIENT_CONFIG_FILE": "/path/to/your/clouds.yaml"
92         }
93       }
94     }
95   }
96   ```
97 
98# Development
99 
100## Setup
101 
102This project supports both `uv` and `tox` for development and testing.
103 
104### Using uv (Fast Local Development)
105 
106```bash
107# Install dependencies (including dev and test groups)
108uv sync
109 
110# Run tests
111uv run --group test pytest
112 
113# Run linting
114uv run ruff check src tests
115 
116# Format code
117uv run ruff format src tests
118```
119 
120### Using tox (OpenStack Standard)
121 
122```bash
123# Install tox
124pip install tox
125# or
126uv tool install tox
127 
128# Run tests
129tox -e py3
130 
131# Run linting
132tox -e pep8
133 
134# Auto-format code
135tox -e format
136 
137# Generate coverage report
138tox -e cover
139 
140# Run arbitrary commands in virtualenv
141tox -e venv -- <command>
142 
143# Test on specific Python version
144tox -e py310  # or py311, py312, py313
145 
146# List all available environments
147tox list
148```
149 
150## Testing
151 
152The project includes comprehensive test coverage (85%+). Tests are located in the `tests/` directory.
153 
154```bash
155# Run all tests
156tox -e py3
157 
158# Run with coverage
159tox -e cover
160 
161# Run with debugger
162tox -e debug
163 
164# Run specific test file
165tox -e py3 -- tests/tools/test_compute_tools.py
166```
167 
168# Contributing
169Contributions are welcome! Please see the [CONTRIBUTING](CONTRIBUTING.rst) file for details on how to contribute to this project.
170 
171# License
172This project is licensed under the Apache License 2.0. See the [LICENSE](LICENSE) file for details.