Openstack mcp server is a Model Context Protocol (MCP) server that provides an interface for AI assistants to interact with OpenStack services.

flowchart LR AI[AI Assistant] <-->|MCP Protocol| Server[OpenStack MCP Server] Server <-->|OpenStack SDK| SDK[OpenStack SDK] SDK <-->|REST API| Cloud[OpenStack Cloud] 

• Table of Contents
• Features
• Quick Start with Claude Desktop
  • Requirements
  • Using python
  • Using uvx
  • Contributing
  • License

• MCP Protocol Support: Implements the Model Context Protocol for AI assistants.
• Compute Tools: Manage OpenStack compute resources (servers, flavors).
• Image Tools: Manage OpenStack images.
• Identity Tools: Handle OpenStack identity and authentication.
• Network Tools: Manage OpenStack networking resources.
• Block Storage Tools: Manage OpenStack block storage resources.

Get started quickly with the OpenStack MCP server using Claude Desktop

• Python 3.10 or higher
• OpenStack credentials configured in clouds.yaml file
• Claude Desktop installed

1. Create or update your clouds.yaml file with your OpenStack credentials.

   Example clouds.yaml:

   clouds: openstack: auth: auth_url: https://your-openstack-auth-url.comusername: your-usernamepassword: your-passwordproject_name: your-project-nameuser_domain_name: Defaultproject_domain_name: Defaultregion_name: your-regioninterface: publicidentity_api_version: 3

2. Create or update your Claude Desktop configuration file:

   • macOS: Edit $HOME/Library/Application Support/Claude/claude_desktop_config.json
   • Windows: Edit %APPDATA%\Claude\claude_desktop_config.json
   • Linux: Edit $HOME/.config/Claude/claude_desktop_config.json

{"mcpServers":{"openstack-mcp-server":{"command": "/path/to/your/python", "args": [ "python-openstackmcp-server" ], "env" :{"OS_CLIENT_CONFIG_FILE": "/path/to/your/clouds.yaml" } } } }

{"mcpServers":{"openstack-mcp-server":{"command": "uvx", "args": [ "python-openstackmcp-server" ], "env" :{"OS_CLIENT_CONFIG_FILE": "/path/to/your/clouds.yaml" } } } }

This project supports both uv and tox for development and testing.

# Install dependencies (including dev and test groups) uv sync # Run tests uv run --group test pytest # Run linting uv run ruff check src tests # Format code uv run ruff format src tests

# Install tox pip install tox # or uv tool install tox # Run tests tox -e py3 # Run linting tox -e pep8 # Auto-format code tox -e format # Generate coverage report tox -e cover # Run arbitrary commands in virtualenv tox -e venv -- <command># Test on specific Python version tox -e py310 # or py311, py312, py313# List all available environments tox list

The project includes comprehensive test coverage (85%+). Tests are located in the tests/ directory.

# Run all tests tox -e py3 # Run with coverage tox -e cover # Run with debugger tox -e debug # Run specific test file tox -e py3 -- tests/tools/test_compute_tools.py

Contributions are welcome! Please see the CONTRIBUTING file for details on how to contribute to this project.

This project is licensed under the Apache License 2.0. See the LICENSE file for details.