python-openstackmcp-server MCP server

Get a specific Compute server.

Get the list of Compute servers. :return: A list of Server objects.

Delete a region.

Get a project.

Delete a Network.

Get detailed information about a specific Port.

Get the list of Identity domains. :return: A list of Domain objects representing the domains.

Delete a project.

Get detailed information about a specific Network.

Get the list of Ports with optional filtering.

Delete a Port.

Delete a domain.

Delete a Subnet.

Delete a Floating IP.

Delete a Router.

Delete a Security Group.

Delete a volume.

Provide cloud configuration with secrets masked of current user's config file. :return: Cloud configuration dictionary with credentials masked.

List interfaces attached to a Router.

Get detailed information about a specific Security Group.

Get detailed information about a specific volume.

Get detailed information about a specific attachment.

Return the currently selected cloud name. :return: current OpenStack cloud name.

Create a new region.

Get allowed address pairs configured on a port.

Remove an interface from a Router by subnet or port. Provide either subnet_id or port_id.

Get a domain.

Get the list of OpenStack images with optional filtering. The filtering behavior is as follows: - By default, all available images are returned without any filtering applied. - Filters are only applied when specific values are provided by the user.

Create a new Openstack image. This method handles both cases of image creation: 1. If a volume is provided, it creates an image from the volume. 2. If no volume is provided, it creates an image using the Image imports method import_options field is required for this method. Following import methods are supported: - glance-direct: The image data is made available to the Image service via the Stage binary - web-download: The image data is made available to the Image service by being posted to an accessible location with a URL that you know. - must provide a URI to the image data. - copy-image: The image data is made available to the Image service by copying existing image - glance-download: The image data is made available to the Image service by fetching an image accessible from another glance service specified by a region name and an image id that you know. - must provide a glance_region and glance_image_id.

Get the list of Subnets with optional filtering. Use this to narrow results by network, project, IP version, gateway presence, and DHCP-enabled state. Notes: - has_gateway is applied client-side after retrieval and checks whether `gateway_ip` is set. - `is_dhcp_enabled` maps to Neutron's `enable_dhcp` filter. - Combining filters further restricts the result (logical AND). Examples: - All IPv4 subnets in a network: `network_id="net-1"`, `ip_version=4` - Only subnets with a gateway: `has_gateway=True` - DHCP-enabled subnets for a project: `project_id="proj-1"`, `is_dhcp_enabled=True`

Create a new Subnet.

Update an existing Port. Only provided parameters are changed; omitted parameters remain untouched. Typical use-cases: - Set admin state down: is_admin_state_up=False - Toggle admin state: read current via get_port_detail(); pass inverted value - Replace security groups: security_group_ids=["sg-1", "sg-2"] - Replace allowed address pairs: 1) current = get_port_allowed_address_pairs(port_id) 2) edit the list (append/remove dicts) 3) update_port(port_id, allowed_address_pairs=current) - Replace fixed IPs: 1) current = get_port_detail(port_id).fixed_ips 2) edit the list 3) update_port(port_id, fixed_ips=current) Notes: - List-typed fields (security groups, allowed address pairs, fixed IPs) replace the entire list with the provided value. Pass [] to remove all entries. - For fixed IPs, each dict typically includes keys like "subnet_id" and/or "ip_address". Examples: - Add a fixed IP: read current, append a new {"subnet_id": "subnet-2", "ip_address": "10.0.1.10"}, then pass fixed_ips=[...] - Clear all security groups: security_group_ids=[]

Create a new Floating IP. Typical use-cases: - Allocate in a pool and attach immediately: provide port_id (and optionally fixed_ip_address). - Allocate for later use: omit port_id (unassigned state). - Add metadata: provide description.

Update Floating IP attributes. Only provided parameters are changed; omitted parameters remain untouched. Typical use-cases: - Attach to a port: port_id="port-1" (optionally fixed_ip_address="10.0.0.10"). - Detach from its port: clear_port=True and omit port_id (sets port_id=None). - Keep current port: clear_port=False and omit port_id. - Update description: description="new desc" or clear with description=None. - Reassign to another port: port_id="new-port" (optionally with fixed_ip_address). Notes: - Passing None for description clears it. - clear_port controls whether to detach when no port_id is provided. - fixed_ip_address is optional and can be provided alongside port_id.

Create a new Router. Typical use-cases: - Create basic router: name="r1" (defaults to admin_state_up=True) - Create distributed router: is_distributed=True - Create with external gateway for north-south traffic: external_gateway_info={"network_id": "ext-net", "enable_snat": True, "external_fixed_ips": [{"subnet_id": "ext-subnet", "ip_address": "203.0.113.10"}]} - Create with project ownership: project_id="proj-1" Notes: - external_gateway_info should follow Neutron schema: at minimum include "network_id"; optional keys include "enable_snat" and "external_fixed_ips".

Add an interface to a Router by subnet or port. Provide either subnet_id or port_id.

List available cloud configurations. :return: Names of OpenStack clouds from user's config file.

Get detailed information about a specific Router.

Update Router attributes atomically. Only provided parameters are changed; omitted parameters remain untouched. Typical use-cases: - Rename and change description: name="r-new", description="d". - Toggle admin state: read current via get_router_detail(); pass inverted bool to is_admin_state_up. - Set distributed flag: is_distributed=True or False. - Set external gateway: external_gateway_info={"network_id": "ext-net", "enable_snat": True, "external_fixed_ips": [...]}. - Clear external gateway: clear_external_gateway=True (takes precedence over external_gateway_info). - Replace static routes: routes=[{"destination": "192.0.2.0/24", "nexthop": "10.0.0.1"}]. Pass [] to remove all routes. Notes: - For list-typed fields (routes), the provided list replaces the entire list on the server. - To clear external gateway, use clear_external_gateway=True. If both provided, clear_external_gateway takes precedence.

Set cloud name to use for later connections. Must set name from currently valid cloud config file.

Get flavors (server hardware configurations). :return: A list of Flavor objects.

Delete an OpenStack image.

Create a new domain.

Get the list of Identity projects. :return: A list of Project objects representing the projects.

Get the list of Block Storage volumes. :return: A list of Volume objects representing the volumes.

Create multiple floating IPs on the specified external network.

Delete a Compute server.

Get an OpenStack image by ID.

Detach a volume from a Compute server.

Assign the first available floating IP from a network to a port. If none are available, create a new one and assign it.

Update a Compute server's name, hostname, or description.

Create a new Network.

Update an existing Network.

Update subnet attributes atomically. Only provided parameters are changed; omitted parameters remain untouched. Typical use-cases: - Set gateway: `gateway_ip="10.0.0.1"`. - Clear gateway: `clear_gateway=True`. - Enable/disable DHCP: `is_dhcp_enabled=True or False`. - Batch updates: update name/description and DNS nameservers together. Notes: - `clear_gateway=True` explicitly clears `gateway_ip` (sets to None). If both `gateway_ip` and `clear_gateway=True` are provided, `clear_gateway` takes precedence. - For list-typed fields (`dns_nameservers`, `allocation_pools`, `host_routes`), the provided list replaces the entire list on the server. Pass `[]` to remove all entries. - For a DHCP toggle, read the current value via `get_subnet_detail()` and pass the inverted boolean to `is_dhcp_enabled`. Examples: - Clear the gateway and disable DHCP: `clear_gateway=True`, `is_dhcp_enabled=False` - Replace DNS servers: `dns_nameservers=["8.8.8.8", "1.1.1.1"]`

Set binding attributes for a port.

Perform an action on a Compute server.

Attach a volume to a Compute server.

Get detailed information about a specific Subnet.

Get the list of Routers with optional filtering.

Get the list of Identity regions. :return: A list of Region objects representing the regions.

Update a region.

Create a new project.

Extend a volume to a new size.

Get the list of attachments.

Get the list of Security Groups with optional filtering.

Update an existing Security Group.

Create a new Security Group.

Create a new Compute server.

Update a project.

Get the list of Floating IPs with optional filtering.

Create a new Port.

Get the list of Networks with optional filtering.

Get a region.

Update a domain.

Create a new volume.