python-openstackmcp-server
OpenStack MCP server for cloud infrastructure management based on openstacksdk.
Author
openstack-kr
Quick Info
Actions
Tags
python-openstackmcp-server
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
- Table of Contents
- Features
- Quick Start with Claude Desktop
- Requirements
- Using python
- Using uvx
- Contributing
- License
Features
- 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.
Quick Start with Claude Desktop
Get started quickly with the OpenStack MCP server using Claude Desktop
Requirements
- Python 3.10 or higher
- OpenStack credentials configured in
clouds.yamlfile -
Claude Desktop installed
-
Create or update your
clouds.yamlfile with your OpenStack credentials.
Example clouds.yaml:
yaml
clouds:
openstack:
auth:
auth_url: https://your-openstack-auth-url.com
username: your-username
password: your-password
project_name: your-project-name
user_domain_name: Default
project_domain_name: Default
region_name: your-region
interface: public
identity_api_version: 3
- 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
Using python
json
{
"mcpServers": {
"openstack-mcp-server": {
"command": "/path/to/your/python",
"args": [
"python-openstackmcp-server"
],
"env" : {
"OS_CLIENT_CONFIG_FILE": "/path/to/your/clouds.yaml"
}
}
}
}
Using uvx
json
{
"mcpServers": {
"openstack-mcp-server": {
"command": "uvx",
"args": [
"python-openstackmcp-server"
],
"env" : {
"OS_CLIENT_CONFIG_FILE": "/path/to/your/clouds.yaml"
}
}
}
}
Contributing
Contributions are welcome! Please see the CONTRIBUTING file for details on how to contribute to this project.
License
This project is licensed under the Apache License 2.0. See the LICENSE file for details.
