# Tool Reference

This page lists all tools that the MCP server exposes, organised by product. All tools are read-only.

For full parameter schemas and return field definitions, see the source documentation in the [<mark style="color:blue;">ionoscloud-mcp repository</mark>](https://github.com/ionos-cloud/ionoscloud-mcp/tree/main/docs).

All tools are registered at startup by default. If you have opted into lazy mode by setting `IONOS_MCP_LOAD_MODE=lazy`, Compute Engine and Object Storage tools register only after you call the matching loader sentinel. For more information, see [<mark style="color:blue;">Selective Tool Loading</mark>](/cloud/ai/mcp-server/configuration/selective-tool-loading.md).

## Loader tools

The loader sentinels below are present **only when `IONOS_MCP_LOAD_MODE=lazy`** is set; in the default eager mode they do not appear because Compute Engine and Object Storage tools are already registered.

| Tool                             | Description                                                                                                |
| -------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| `ionos_load_compute_tools`       | Registers all 50 Compute Engine tools and notifies the client to refresh its tool catalog (lazy mode only) |
| `ionos_load_objectstorage_tools` | Registers all 23 Object Storage tools and notifies the client to refresh its tool catalog (lazy mode only) |

## Most commonly used tools

If you are just getting started, these tools cover the most frequent use cases:

| Tool                            | What it does                                                                         |
| ------------------------------- | ------------------------------------------------------------------------------------ |
| `list_datacenters`              | Entry point for all Compute exploration; lists your data centers and their locations |
| `list_servers`                  | Lists servers in a data center                                                       |
| `list_billing_invoices`         | Lists your invoices; starting point for cost checks                                  |
| `get_billing_utilization_daily` | Daily resource usage breakdown; starting point for cost analysis                     |
| `list_dns_zones`                | Lists all DNS zones; starting point for DNS audit                                    |
| `list_object_storage_buckets`   | Lists all Object Storage buckets                                                     |
| `get_contract`                  | Shows account-level resource limits and contract information                         |
| `list_activitylog_events`       | Queries the full API audit trail: who did what, when, on which resource              |

## [<mark style="color:blue;">Compute Engine</mark>](https://docs.ionos.com/cloud/compute-services/compute-engine)

### Data centers

| Tool               | Description                           |
| ------------------ | ------------------------------------- |
| `list_datacenters` | List all data centers in your account |
| `get_datacenter`   | Get details of a specific data center |

### Servers

| Tool                        | Description                             |
| --------------------------- | --------------------------------------- |
| `list_servers`              | List all servers in a data center       |
| `get_server`                | Get details of a specific server        |
| `list_server_volumes`       | List volumes attached to a server       |
| `list_server_cdroms`        | List CD-ROMs attached to a server       |
| `list_server_gpus`          | List GPUs attached to a server          |
| `get_server_gpu`            | Get details of a specific GPU           |
| `get_server_remote_console` | Get the remote console URL for a server |

### Volumes

| Tool           | Description                       |
| -------------- | --------------------------------- |
| `list_volumes` | List all volumes in a data center |
| `get_volume`   | Get details of a specific volume  |

### NICs

| Tool        | Description                   |
| ----------- | ----------------------------- |
| `list_nics` | List all NICs on a server     |
| `get_nic`   | Get details of a specific NIC |

### LANs

| Tool            | Description                    |
| --------------- | ------------------------------ |
| `list_lans`     | List all LANs in a data center |
| `get_lan`       | Get details of a specific LAN  |
| `list_lan_nics` | List NICs connected to a LAN   |

### Firewall rules

| Tool                  | Description                             |
| --------------------- | --------------------------------------- |
| `list_firewall_rules` | List firewall rules on a NIC            |
| `get_firewall_rule`   | Get details of a specific firewall rule |

### IP blocks

| Tool             | Description                        |
| ---------------- | ---------------------------------- |
| `list_ip_blocks` | List all IP blocks in your account |
| `get_ip_block`   | Get details of a specific IP block |

### Load balancers

| Tool                     | Description                               |
| ------------------------ | ----------------------------------------- |
| `list_loadbalancers`     | List all load balancers in a data center  |
| `get_loadbalancer`       | Get details of a specific load balancer   |
| `list_loadbalancer_nics` | List NICs associated with a load balancer |

### Network load balancers

| Tool                         | Description                                      |
| ---------------------------- | ------------------------------------------------ |
| `list_network_loadbalancers` | List all network load balancers in a data center |
| `get_network_loadbalancer`   | Get details of a specific network load balancer  |
| `list_nlb_forwarding_rules`  | List forwarding rules of a network load balancer |

### Application load balancers

| Tool                             | Description                                           |
| -------------------------------- | ----------------------------------------------------- |
| `list_application_loadbalancers` | List all application load balancers in a data center  |
| `get_application_loadbalancer`   | Get details of a specific application load balancer   |
| `list_alb_forwarding_rules`      | List forwarding rules of an application load balancer |

### Target groups

| Tool                 | Description                            |
| -------------------- | -------------------------------------- |
| `list_target_groups` | List all target groups in your account |
| `get_target_group`   | Get details of a specific target group |

### NAT gateways

| Tool                     | Description                            |
| ------------------------ | -------------------------------------- |
| `list_nat_gateways`      | List all NAT gateways in a data center |
| `get_nat_gateway`        | Get details of a specific NAT gateway  |
| `list_nat_gateway_rules` | List rules of a NAT gateway            |

### Security groups

| Tool                        | Description                                   |
| --------------------------- | --------------------------------------------- |
| `list_security_groups`      | List all security groups in a data center     |
| `get_security_group`        | Get details of a specific security group      |
| `list_security_group_rules` | List rules in a security group                |
| `get_security_group_rule`   | Get details of a specific security group rule |

### Private cross connects

| Tool                          | Description                                     |
| ----------------------------- | ----------------------------------------------- |
| `list_private_cross_connects` | List all private cross connects in your account |
| `get_private_cross_connect`   | Get details of a specific private cross connect |

### Snapshots

| Tool             | Description                        |
| ---------------- | ---------------------------------- |
| `list_snapshots` | List all snapshots in your account |
| `get_snapshot`   | Get details of a specific snapshot |

### Images

| Tool          | Description               |
| ------------- | ------------------------- |
| `list_images` | List all available images |

### Templates

| Tool             | Description                        |
| ---------------- | ---------------------------------- |
| `list_templates` | List all server templates          |
| `get_template`   | Get details of a specific template |

### Locations

| Tool             | Description                              |
| ---------------- | ---------------------------------------- |
| `list_locations` | List all available IONOS CLOUD locations |

### Requests

| Tool                 | Description                               |
| -------------------- | ----------------------------------------- |
| `list_requests`      | List recent API requests and their status |
| `get_request`        | Get details of a specific request         |
| `get_request_status` | Get the current status of a request       |

### Contract

| Tool           | Description                                                  |
| -------------- | ------------------------------------------------------------ |
| `get_contract` | Get contract and resource limit information for your account |

## [<mark style="color:blue;">IONOS CLOUD Object Storage</mark>](https://docs.ionos.com/cloud/backup-and-storage/ionos-object-storage)

### Buckets

| Tool                                 | Description                                             |
| ------------------------------------ | ------------------------------------------------------- |
| `list_object_storage_buckets`        | List all Object Storage buckets in your account         |
| `get_object_storage_bucket_location` | Get the location of a bucket                            |
| `head_object_storage_bucket`         | Check whether a bucket exists and retrieve its metadata |

### Bucket configuration

| Tool                                            | Description                                              |
| ----------------------------------------------- | -------------------------------------------------------- |
| `get_object_storage_bucket_cors`                | Get the CORS configuration of a bucket                   |
| `get_object_storage_bucket_encryption`          | Get the server-side encryption configuration of a bucket |
| `get_object_storage_bucket_lifecycle`           | Get the lifecycle configuration of a bucket              |
| `get_object_storage_bucket_policy`              | Get the bucket policy                                    |
| `get_object_storage_bucket_policy_status`       | Get the public access status of the bucket policy        |
| `get_object_storage_bucket_replication`         | Get the replication configuration of a bucket            |
| `get_object_storage_bucket_tagging`             | Get the tags applied to a bucket                         |
| `get_object_storage_bucket_versioning`          | Get the versioning configuration of a bucket             |
| `get_object_storage_bucket_public_access_block` | Get the public access block configuration of a bucket    |
| `get_object_storage_bucket_lock_configuration`  | Get the Object Lock configuration of a bucket            |

### Objects

| Tool                                   | Description                                              |
| -------------------------------------- | -------------------------------------------------------- |
| `list_object_storage_objects`          | List objects in a bucket                                 |
| `head_object_storage_object`           | Check whether an object exists and retrieve its metadata |
| `list_object_storage_object_versions`  | List versions of an object                               |
| `get_object_storage_object_tagging`    | Get the tags applied to an object                        |
| `get_object_storage_object_retention`  | Get the retention settings of an object                  |
| `get_object_storage_object_legal_hold` | Get the legal hold status of an object                   |

### Access keys

| Tool                              | Description                                         |
| --------------------------------- | --------------------------------------------------- |
| `list_object_storage_access_keys` | List all Object Storage access keys in your account |
| `get_object_storage_access_key`   | Get details of a specific access key                |

### Regions

| Tool                          | Description                                     |
| ----------------------------- | ----------------------------------------------- |
| `list_object_storage_regions` | List all available Object Storage regions       |
| `get_object_storage_region`   | Get details of a specific Object Storage region |

## [<mark style="color:blue;">Cloud DNS</mark>](https://docs.ionos.com/cloud/network-services/cloud-dns)

### Zones

| Tool                | Description                        |
| ------------------- | ---------------------------------- |
| `list_dns_zones`    | List all DNS zones in your account |
| `get_dns_zone`      | Get details of a specific DNS zone |
| `get_dns_zone_file` | Get the zone file for a DNS zone   |

### Records

| Tool                              | Description                             |
| --------------------------------- | --------------------------------------- |
| `list_dns_records`                | List all DNS records across all zones   |
| `list_dns_zone_records`           | List all records in a specific DNS zone |
| `get_dns_record`                  | Get details of a specific DNS record    |
| `list_dns_secondary_zone_records` | List records in a secondary DNS zone    |

### Reverse records

| Tool                       | Description                                  |
| -------------------------- | -------------------------------------------- |
| `list_dns_reverse_records` | List all reverse DNS records                 |
| `get_dns_reverse_record`   | Get details of a specific reverse DNS record |

### Secondary zones

| Tool                          | Description                                  |
| ----------------------------- | -------------------------------------------- |
| `list_dns_secondary_zones`    | List all secondary DNS zones                 |
| `get_dns_secondary_zone`      | Get details of a specific secondary DNS zone |
| `get_dns_secondary_zone_axfr` | Get the AXFR status of a secondary DNS zone  |

### DNSSEC

| Tool                        | Description                     |
| --------------------------- | ------------------------------- |
| `list_dns_zone_dnssec_keys` | List DNSSEC keys for a DNS zone |

### Quota

| Tool            | Description                              |
| --------------- | ---------------------------------------- |
| `get_dns_quota` | Get DNS quota and usage for your account |

## [<mark style="color:blue;">Billing</mark>](https://docs.ionos.com/cloud/management/usage/cost-and-usage)

All Billing tools are available at startup; no loader call required.

The billing tools return native IONOS API fields. To produce **FOCUS v1.3** (FinOps Open Cost and Usage Specification) output, the server ships the full column mapping in two equivalent forms:

* the MCP resource `ionos://billing/focus-v1.3` (preferred when the AI client supports `resources/read`)
* the tool `get_billing_focus_spec` (use this when the client does not expose resources)

Ask your AI assistant to read whichever is available, then apply the mapping to the raw tool responses. For more information, see [<mark style="color:blue;">FinOps and FOCUS Billing</mark>](/cloud/ai/mcp-server/use-cases/finops-focus-billing.md). Currency follows the contract billing currency; timestamps are UTC ISO-8601; quantity units depend on the resource (see `PricingUnit` in the pricing catalog).

### FOCUS

| Tool                     | Description                                                                                                                                                                                                        |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `get_billing_focus_spec` | Returns the FOCUS v1.3 column specification and IONOS tool → FOCUS field mappings. Equivalent to reading the `ionos://billing/focus-v1.3` resource; use this when your AI client does not support `resources/read` |

### Profile

| Tool                  | Description                              |
| --------------------- | ---------------------------------------- |
| `get_billing_profile` | Get the billing profile for your account |

### Invoices

| Tool                              | Description                                 |
| --------------------------------- | ------------------------------------------- |
| `list_billing_invoices`           | List all invoices                           |
| `list_billing_invoices_by_period` | List invoices for a specific billing period |
| `get_billing_invoice`             | Get details of a specific invoice           |

### EVN (provisioning intervals)

An EVN record captures the start and end of each billed provisioning interval for a resource: the unit that <code class="expression">space.vars.ionos\_cloud</code> uses to calculate hourly charges. Each time a resource is created, resized, or deleted, a new EVN record is produced.

| Tool                         | Description                                             |
| ---------------------------- | ------------------------------------------------------- |
| `list_billing_evn`           | List all provisioning interval records                  |
| `list_billing_evn_by_period` | List provisioning interval records for a billing period |

### Traffic

| Tool                             | Description                                      |
| -------------------------------- | ------------------------------------------------ |
| `list_billing_traffic`           | List traffic usage records                       |
| `list_billing_traffic_by_period` | List traffic usage for a specific billing period |

### Usage

| Tool                              | Description                               |
| --------------------------------- | ----------------------------------------- |
| `list_billing_usage`              | List resource usage records               |
| `get_billing_usage_by_datacenter` | Get resource usage grouped by data center |

### Utilization

| Tool                                 | Description                              |
| ------------------------------------ | ---------------------------------------- |
| `list_billing_utilization`           | List usage records                       |
| `list_billing_utilization_by_period` | List usage for a specific billing period |
| `get_billing_utilization_daily`      | Get daily usage for a specific period    |

### Products

| Tool                    | Description                                  |
| ----------------------- | -------------------------------------------- |
| `list_billing_products` | List the IONOS CLOUD product pricing catalog |

## [<mark style="color:blue;">Activity Log</mark>](https://docs.ionos.com/cloud/observability/activity-logs)

All Activity Log tools are available at startup; no loader call required. They appear in the catalog regardless of token privileges; if the token is missing the `ACCESS_ACTIVITY_LOG` privilege, calls return 403 even though the tools are listed. For more information, see [<mark style="color:blue;">Authentication</mark>](/cloud/ai/mcp-server/configuration/authentication.md).

### Contracts

| Tool                         | Description                                                                                                             |
| ---------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| `list_activitylog_contracts` | List contracts available for Activity Log queries; primarily for reseller and partner users managing multiple contracts |

### Events

| Tool                      | Description                                                                                                                                                                                                           |
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `list_activitylog_events` | Query the full API audit trail for a contract: who did what, when, on which resource. Supports date range, user, and event type filters. Defaults to the last 7 days, 25 events, excluding high-volume status updates |

## [<mark style="color:blue;">Certificate Manager</mark>](https://docs.ionos.com/cloud/security/certificate-manager)

### Certificates

| Tool                     | Description                           |
| ------------------------ | ------------------------------------- |
| `list_cert_certificates` | List all certificates                 |
| `get_cert_certificate`   | Get details of a specific certificate |

### Auto-certificates

| Tool                          | Description                                |
| ----------------------------- | ------------------------------------------ |
| `list_cert_auto_certificates` | List all auto-certificates                 |
| `get_cert_auto_certificate`   | Get details of a specific auto-certificate |

### Providers

| Tool                  | Description                                    |
| --------------------- | ---------------------------------------------- |
| `list_cert_providers` | List all certificate providers                 |
| `get_cert_provider`   | Get details of a specific certificate provider |

## Initial release scope boundaries

The following are explicitly out of scope in this initial release:

| Product                    | Not included in this release                                                                          |
| -------------------------- | ----------------------------------------------------------------------------------------------------- |
| Compute Engine             | Real-time metrics, health checks, autoscaling configuration, console access beyond remote-console URL |
| IONOS CLOUD Object Storage | Bucket metrics, replication status monitoring, inventory reports                                      |
| Cloud DNS                  | Dynamic DNS, zone transfer triggering (AXFR status is readable, not triggerable)                      |
| Billing                    | Payment methods, invoice download, budget alerts configuration                                        |
| Certificate Manager        | Certificate issuance or renewal                                                                       |
| All products               | Any create, update, or delete operations                                                              |

## Next steps

* [<mark style="color:blue;">Use Cases</mark>](/cloud/ai/mcp-server/use-cases.md): see the tools in action in real workflows
* [<mark style="color:blue;">Quick Start</mark>](/cloud/ai/mcp-server/quick-start.md): connect to your first AI client
* [<mark style="color:blue;">Selective Tool Loading</mark>](/cloud/ai/mcp-server/configuration/selective-tool-loading.md): if Compute or Object Storage tools are not visible


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.ionos.com/cloud/ai/mcp-server/tool-reference.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.