@robinmordasiewicz/f5xc-terraform-mcp 2.3.0 → 2.4.3

package/README.md

@@ -56,31 +56,114 @@ Or if running from source:
 }
 ```
 
+### Claude Code (CLI)
+
+Install the MCP server with a single command:
+
+```bash
+claude mcp add f5xc-terraform -- npx -y @robinmordasiewicz/f5xc-terraform-mcp
+```
+
+**Scope Options:**
+
+- `--scope local` (default): Available only in the current directory
+- `--scope project`: Shared with anyone who clones the repository (saved in `.mcp.json`)
+- `--scope user`: Available in all your Claude Code sessions
+
+Examples with different scopes:
+
+```bash
+# User-wide installation (recommended for personal use)
+claude mcp add --scope user f5xc-terraform -- npx -y @robinmordasiewicz/f5xc-terraform-mcp
+
+# Project-specific installation (for team collaboration)
+claude mcp add --scope project f5xc-terraform -- npx -y @robinmordasiewicz/f5xc-terraform-mcp
+```
+
+**Verify Installation:**
+
+```bash
+claude mcp list
+```
+
+You should see `f5xc-terraform` listed with a `✓ Connected` status.
+
+**Remove Server:**
+
+```bash
+claude mcp remove f5xc-terraform
+```
+
+### Visual Studio Code (with GitHub Copilot)
+
+VS Code 1.99+ supports MCP servers through GitHub Copilot. Configure by creating a `.vscode/mcp.json` file in your workspace:
+
+```json
+{
+  "servers": {
+    "f5xc-terraform": {
+      "command": "npx",
+      "args": ["-y", "@robinmordasiewicz/f5xc-terraform-mcp"]
+    }
+  }
+}
+```
+
+**Alternative: Command Palette**
+
+1. Open Command Palette (`Ctrl+Shift+P` / `Cmd+Shift+P`)
+2. Run `MCP: Add Server`
+3. Select `npm package`
+4. Enter: `@robinmordasiewicz/f5xc-terraform-mcp`
+
+**Alternative: Command Line**
+
+```bash
+code --add-mcp "{\"name\":\"f5xc-terraform\",\"command\":\"npx\",\"args\":[\"-y\",\"@robinmordasiewicz/f5xc-terraform-mcp\"]}"
+```
+
+**Global Configuration (User Settings)**
+
+To make the MCP server available across all workspaces, add to your VS Code user settings (`settings.json`):
+
+```json
+{
+  "mcp": {
+    "servers": {
+      "f5xc-terraform": {
+        "command": "npx",
+        "args": ["-y", "@robinmordasiewicz/f5xc-terraform-mcp"]
+      }
+    }
+  }
+}
+```
+
 ## Available Tools
 
 ### Documentation Tools
 
 | Tool | Description |
 |------|-------------|
-| `f5xc_search_docs` | Search provider documentation by keyword |
-| `f5xc_get_doc` | Get complete documentation for a resource |
-| `f5xc_list_docs` | List all available documentation |
+| `f5xc_terraform_search_docs` | Search provider documentation by keyword |
+| `f5xc_terraform_get_doc` | Get complete documentation for a resource |
+| `f5xc_terraform_list_docs` | List all available documentation |
 
 ### API Specification Tools
 
 | Tool | Description |
 |------|-------------|
-| `f5xc_search_api_specs` | Search OpenAPI specifications |
-| `f5xc_get_api_spec` | Get a specific API specification |
-| `f5xc_find_endpoints` | Find API endpoints by URL pattern |
-| `f5xc_get_schema_definition` | Get a schema definition from a spec |
-| `f5xc_list_definitions` | List all definitions in a spec |
+| `f5xc_terraform_search_api_specs` | Search OpenAPI specifications |
+| `f5xc_terraform_get_api_spec` | Get a specific API specification |
+| `f5xc_terraform_find_endpoints` | Find API endpoints by URL pattern |
+| `f5xc_terraform_get_schema_definition` | Get a schema definition from a spec |
+| `f5xc_terraform_list_definitions` | List all definitions in a spec |
 
 ### Utility Tools
 
 | Tool | Description |
 |------|-------------|
-| `f5xc_get_summary` | Get overview of all available docs and specs |
+| `f5xc_terraform_get_summary` | Get overview of all available docs and specs |
 
 ## Usage Examples
 
@@ -89,8 +172,8 @@ Or if running from source:
 ```
 User: How do I configure an HTTP load balancer in F5XC with Terraform?
 
-Claude: [Uses f5xc_search_docs with query "http_loadbalancer"]
-        [Uses f5xc_get_doc with name "http_loadbalancer"]
+Claude: [Uses f5xc_terraform_search_docs with query "http_loadbalancer"]
+        [Uses f5xc_terraform_get_doc with name "http_loadbalancer"]
 ```
 
 ### Discover API Endpoints
@@ -98,7 +181,7 @@ Claude: [Uses f5xc_search_docs with query "http_loadbalancer"]
 ```
 User: What API endpoints are available for managing namespaces?
 
-Claude: [Uses f5xc_find_endpoints with pattern "/namespaces"]
+Claude: [Uses f5xc_terraform_find_endpoints with pattern "/namespaces"]
 ```
 
 ### Explore Schema Definitions
@@ -106,9 +189,9 @@ Claude: [Uses f5xc_find_endpoints with pattern "/namespaces"]
 ```
 User: What fields are available in the app_firewall configuration?
 
-Claude: [Uses f5xc_get_api_spec with name "app_firewall"]
-        [Uses f5xc_list_definitions with spec_name "app_firewall"]
-        [Uses f5xc_get_schema_definition for specific type]
+Claude: [Uses f5xc_terraform_get_api_spec with name "app_firewall"]
+        [Uses f5xc_terraform_list_definitions with spec_name "app_firewall"]
+        [Uses f5xc_terraform_get_schema_definition for specific type]
 ```
 
 ## Development

package/dist/docs/data-sources/addon_subscription.md

@@ -0,0 +1,51 @@
+---
+page_title: "f5xc_addon_subscription Data Source - terraform-provider-f5xc"
+subcategory: "Subscriptions"
+description: |-
+  [Namespace: required] Manages new Addon Subscription with Addon Subscription State in F5 Distributed Cloud.
+---
+
+# f5xc_addon_subscription (Data Source)
+
+[Namespace: required] Manages new Addon Subscription with Addon Subscription State in F5 Distributed Cloud.
+
+~> **Note** Please refer to [Addon Subscription API docs](https://docs.cloud.f5.com/docs-v2/api/pbac-addon-subscription) to learn more.
+
+## Example Usage
+
+```terraform
+# Addon Subscription Data Source Example
+# Retrieves information about an existing Addon Subscription
+
+# Look up an existing Addon Subscription by name
+data "f5xc_addon_subscription" "example" {
+  name      = "example-addon-subscription"
+  namespace = "system"
+}
+
+# Example: Use the data source in another resource
+# output "addon_subscription_id" {
+#   value = data.f5xc_addon_subscription.example.id
+# }
+```
+
+<!-- schema generated by tfplugindocs -->
+## Argument Reference
+
+### Metadata Argument Reference
+
+<a id="name"></a>&#x2022; [`name`](#name) - Required String<br>Name of the AddonSubscription
+
+<a id="namespace"></a>&#x2022; [`namespace`](#namespace) - Required String<br>Namespace where the AddonSubscription exists
+
+### Attributes Reference
+
+In addition to all arguments above, the following attributes are exported:
+
+<a id="annotations"></a>&#x2022; [`annotations`](#annotations) - Optional Map<br>Annotations applied to this resource
+
+<a id="description"></a>&#x2022; [`description`](#description) - Optional String<br>Description of the AddonSubscription
+
+<a id="id"></a>&#x2022; [`id`](#id) - Optional String<br>Unique identifier for the resource
+
+<a id="labels"></a>&#x2022; [`labels`](#labels) - Optional Map<br>Labels applied to this resource

package/dist/docs/data-sources/address_allocator.md

@@ -0,0 +1,51 @@
+---
+page_title: "f5xc_address_allocator Data Source - terraform-provider-f5xc"
+subcategory: "Cloud Resources"
+description: |-
+  [Namespace: required] Manages Address Allocator will create an address allocator object in 'system' namespace of the user in F5 Distributed Cloud.
+---
+
+# f5xc_address_allocator (Data Source)
+
+[Namespace: required] Manages Address Allocator will create an address allocator object in 'system' namespace of the user in F5 Distributed Cloud.
+
+~> **Note** Please refer to [Address Allocator API docs](https://docs.cloud.f5.com/docs-v2/api/address-allocator) to learn more.
+
+## Example Usage
+
+```terraform
+# Address Allocator Data Source Example
+# Retrieves information about an existing Address Allocator
+
+# Look up an existing Address Allocator by name
+data "f5xc_address_allocator" "example" {
+  name      = "example-address-allocator"
+  namespace = "system"
+}
+
+# Example: Use the data source in another resource
+# output "address_allocator_id" {
+#   value = data.f5xc_address_allocator.example.id
+# }
+```
+
+<!-- schema generated by tfplugindocs -->
+## Argument Reference
+
+### Metadata Argument Reference
+
+<a id="name"></a>&#x2022; [`name`](#name) - Required String<br>Name of the AddressAllocator
+
+<a id="namespace"></a>&#x2022; [`namespace`](#namespace) - Required String<br>Namespace where the AddressAllocator exists
+
+### Attributes Reference
+
+In addition to all arguments above, the following attributes are exported:
+
+<a id="annotations"></a>&#x2022; [`annotations`](#annotations) - Optional Map<br>Annotations applied to this resource
+
+<a id="description"></a>&#x2022; [`description`](#description) - Optional String<br>Description of the AddressAllocator
+
+<a id="id"></a>&#x2022; [`id`](#id) - Optional String<br>Unique identifier for the resource
+
+<a id="labels"></a>&#x2022; [`labels`](#labels) - Optional Map<br>Labels applied to this resource

package/dist/docs/data-sources/advertise_policy.md

@@ -0,0 +1,51 @@
+---
+page_title: "f5xc_advertise_policy Data Source - terraform-provider-f5xc"
+subcategory: "Load Balancing"
+description: |-
+  [Namespace: required] Manages a Advertise Policy resource in F5 Distributed Cloud for advertise_policy object controls how and where a service represented by a given virtual_host object is advertised to consumers. configuration.
+---
+
+# f5xc_advertise_policy (Data Source)
+
+[Namespace: required] Manages a Advertise Policy resource in F5 Distributed Cloud for advertise_policy object controls how and where a service represented by a given virtual_host object is advertised to consumers. configuration.
+
+~> **Note** Please refer to [Advertise Policy API docs](https://docs.cloud.f5.com/docs-v2/api/advertise-policy) to learn more.
+
+## Example Usage
+
+```terraform
+# Advertise Policy Data Source Example
+# Retrieves information about an existing Advertise Policy
+
+# Look up an existing Advertise Policy by name
+data "f5xc_advertise_policy" "example" {
+  name      = "example-advertise-policy"
+  namespace = "system"
+}
+
+# Example: Use the data source in another resource
+# output "advertise_policy_id" {
+#   value = data.f5xc_advertise_policy.example.id
+# }
+```
+
+<!-- schema generated by tfplugindocs -->
+## Argument Reference
+
+### Metadata Argument Reference
+
+<a id="name"></a>&#x2022; [`name`](#name) - Required String<br>Name of the AdvertisePolicy
+
+<a id="namespace"></a>&#x2022; [`namespace`](#namespace) - Required String<br>Namespace where the AdvertisePolicy exists
+
+### Attributes Reference
+
+In addition to all arguments above, the following attributes are exported:
+
+<a id="annotations"></a>&#x2022; [`annotations`](#annotations) - Optional Map<br>Annotations applied to this resource
+
+<a id="description"></a>&#x2022; [`description`](#description) - Optional String<br>Description of the AdvertisePolicy
+
+<a id="id"></a>&#x2022; [`id`](#id) - Optional String<br>Unique identifier for the resource
+
+<a id="labels"></a>&#x2022; [`labels`](#labels) - Optional Map<br>Labels applied to this resource

package/dist/docs/data-sources/alert_policy.md

@@ -0,0 +1,51 @@
+---
+page_title: "f5xc_alert_policy Data Source - terraform-provider-f5xc"
+subcategory: "Security"
+description: |-
+  [Category: Monitoring] [Namespace: required] Manages a Alert Policy resource in F5 Distributed Cloud for alerting rules and notification policies.
+---
+
+# f5xc_alert_policy (Data Source)
+
+[Category: Monitoring] [Namespace: required] Manages a Alert Policy resource in F5 Distributed Cloud for alerting rules and notification policies.
+
+~> **Note** Please refer to [Alert Policy API docs](https://docs.cloud.f5.com/docs-v2/api/alert-policy) to learn more.
+
+## Example Usage
+
+```terraform
+# Alert Policy Data Source Example
+# Retrieves information about an existing Alert Policy
+
+# Look up an existing Alert Policy by name
+data "f5xc_alert_policy" "example" {
+  name      = "example-alert-policy"
+  namespace = "system"
+}
+
+# Example: Use the data source in another resource
+# output "alert_policy_id" {
+#   value = data.f5xc_alert_policy.example.id
+# }
+```
+
+<!-- schema generated by tfplugindocs -->
+## Argument Reference
+
+### Metadata Argument Reference
+
+<a id="name"></a>&#x2022; [`name`](#name) - Required String<br>Name of the AlertPolicy
+
+<a id="namespace"></a>&#x2022; [`namespace`](#namespace) - Required String<br>Namespace where the AlertPolicy exists
+
+### Attributes Reference
+
+In addition to all arguments above, the following attributes are exported:
+
+<a id="annotations"></a>&#x2022; [`annotations`](#annotations) - Optional Map<br>Annotations applied to this resource
+
+<a id="description"></a>&#x2022; [`description`](#description) - Optional String<br>Description of the AlertPolicy
+
+<a id="id"></a>&#x2022; [`id`](#id) - Optional String<br>Unique identifier for the resource
+
+<a id="labels"></a>&#x2022; [`labels`](#labels) - Optional Map<br>Labels applied to this resource

package/dist/docs/data-sources/alert_receiver.md

@@ -0,0 +1,62 @@
+---
+page_title: "f5xc_alert_receiver Data Source - terraform-provider-f5xc"
+subcategory: "Monitoring"
+description: |-
+  [Category: Monitoring] [Namespace: required] Manages a Alert Receiver resource in F5 Distributed Cloud for alert notification endpoints.
+---
+
+# f5xc_alert_receiver (Data Source)
+
+[Category: Monitoring] [Namespace: required] Manages a Alert Receiver resource in F5 Distributed Cloud for alert notification endpoints.
+
+~> **Note** Please refer to [Alert Receiver API docs](https://docs.cloud.f5.com/docs-v2/api/alert-receiver) to learn more.
+
+## Example Usage
+
+```terraform
+# Alert Receiver Data Source Example
+# Retrieves information about an existing Alert Receiver
+
+# Look up an existing Alert Receiver by name
+data "f5xc_alert_receiver" "example" {
+  name      = "example-alert-receiver"
+  namespace = "system"
+}
+
+# Example: Use the data source in another resource
+# output "alert_receiver_id" {
+#   value = data.f5xc_alert_receiver.example.id
+# }
+
+# Example: Reference alert receiver in alert policy
+# resource "f5xc_alert_policy" "example" {
+#   name      = "example-policy"
+#   namespace = "system"
+#
+#   receivers {
+#     name      = data.f5xc_alert_receiver.example.name
+#     namespace = data.f5xc_alert_receiver.example.namespace
+#   }
+# }
+```
+
+<!-- schema generated by tfplugindocs -->
+## Argument Reference
+
+### Metadata Argument Reference
+
+<a id="name"></a>&#x2022; [`name`](#name) - Required String<br>Name of the AlertReceiver
+
+<a id="namespace"></a>&#x2022; [`namespace`](#namespace) - Required String<br>Namespace where the AlertReceiver exists
+
+### Attributes Reference
+
+In addition to all arguments above, the following attributes are exported:
+
+<a id="annotations"></a>&#x2022; [`annotations`](#annotations) - Optional Map<br>Annotations applied to this resource
+
+<a id="description"></a>&#x2022; [`description`](#description) - Optional String<br>Description of the AlertReceiver
+
+<a id="id"></a>&#x2022; [`id`](#id) - Optional String<br>Unique identifier for the resource
+
+<a id="labels"></a>&#x2022; [`labels`](#labels) - Optional Map<br>Labels applied to this resource

package/dist/docs/data-sources/allowed_tenant.md

@@ -0,0 +1,51 @@
+---
+page_title: "f5xc_allowed_tenant Data Source - terraform-provider-f5xc"
+subcategory: "Organization"
+description: |-
+  [Category: Organization] [Namespace: not_required] Manages allowed_tenant config instance. Name of the object is name of the tenant that is allowed to manage. in F5 Distributed Cloud.
+---
+
+# f5xc_allowed_tenant (Data Source)
+
+[Category: Organization] [Namespace: not_required] Manages allowed_tenant config instance. Name of the object is name of the tenant that is allowed to manage. in F5 Distributed Cloud.
+
+~> **Note** Please refer to [Allowed Tenant API docs](https://docs.cloud.f5.com/docs-v2/api/tenant-management-allowed-tenant) to learn more.
+
+## Example Usage
+
+```terraform
+# Allowed Tenant Data Source Example
+# Retrieves information about an existing Allowed Tenant
+
+# Look up an existing Allowed Tenant by name
+data "f5xc_allowed_tenant" "example" {
+  name      = "example-allowed-tenant"
+  namespace = "system"
+}
+
+# Example: Use the data source in another resource
+# output "allowed_tenant_id" {
+#   value = data.f5xc_allowed_tenant.example.id
+# }
+```
+
+<!-- schema generated by tfplugindocs -->
+## Argument Reference
+
+### Metadata Argument Reference
+
+<a id="name"></a>&#x2022; [`name`](#name) - Required String<br>Name of the AllowedTenant
+
+<a id="namespace"></a>&#x2022; [`namespace`](#namespace) - Required String<br>Namespace where the AllowedTenant exists
+
+### Attributes Reference
+
+In addition to all arguments above, the following attributes are exported:
+
+<a id="annotations"></a>&#x2022; [`annotations`](#annotations) - Optional Map<br>Annotations applied to this resource
+
+<a id="description"></a>&#x2022; [`description`](#description) - Optional String<br>Description of the AllowedTenant
+
+<a id="id"></a>&#x2022; [`id`](#id) - Optional String<br>Unique identifier for the resource
+
+<a id="labels"></a>&#x2022; [`labels`](#labels) - Optional Map<br>Labels applied to this resource

package/dist/docs/data-sources/api_crawler.md

@@ -0,0 +1,51 @@
+---
+page_title: "f5xc_api_crawler Data Source - terraform-provider-f5xc"
+subcategory: "API Security"
+description: |-
+  [Category: API Security] [Namespace: required] Manages a API Crawler resource in F5 Distributed Cloud.
+---
+
+# f5xc_api_crawler (Data Source)
+
+[Category: API Security] [Namespace: required] Manages a API Crawler resource in F5 Distributed Cloud.
+
+~> **Note** Please refer to [API Crawler API docs](https://docs.cloud.f5.com/docs-v2/api/api-sec-api-crawler) to learn more.
+
+## Example Usage
+
+```terraform
+# API Crawler Data Source Example
+# Retrieves information about an existing API Crawler
+
+# Look up an existing API Crawler by name
+data "f5xc_api_crawler" "example" {
+  name      = "example-api-crawler"
+  namespace = "system"
+}
+
+# Example: Use the data source in another resource
+# output "api_crawler_id" {
+#   value = data.f5xc_api_crawler.example.id
+# }
+```
+
+<!-- schema generated by tfplugindocs -->
+## Argument Reference
+
+### Metadata Argument Reference
+
+<a id="name"></a>&#x2022; [`name`](#name) - Required String<br>Name of the APICrawler
+
+<a id="namespace"></a>&#x2022; [`namespace`](#namespace) - Required String<br>Namespace where the APICrawler exists
+
+### Attributes Reference
+
+In addition to all arguments above, the following attributes are exported:
+
+<a id="annotations"></a>&#x2022; [`annotations`](#annotations) - Optional Map<br>Annotations applied to this resource
+
+<a id="description"></a>&#x2022; [`description`](#description) - Optional String<br>Description of the APICrawler
+
+<a id="id"></a>&#x2022; [`id`](#id) - Optional String<br>Unique identifier for the resource
+
+<a id="labels"></a>&#x2022; [`labels`](#labels) - Optional Map<br>Labels applied to this resource

package/dist/docs/data-sources/api_credential.md

@@ -0,0 +1,51 @@
+---
+page_title: "f5xc_api_credential Data Source - terraform-provider-f5xc"
+subcategory: "Authentication"
+description: |-
+  [Category: Authentication] [Namespace: required] Manages request specification. in F5 Distributed Cloud.
+---
+
+# f5xc_api_credential (Data Source)
+
+[Category: Authentication] [Namespace: required] Manages request specification. in F5 Distributed Cloud.
+
+~> **Note** Please refer to [API Credential API docs](https://docs.cloud.f5.com/docs-v2/api/api-credential) to learn more.
+
+## Example Usage
+
+```terraform
+# API Credential Data Source Example
+# Retrieves information about an existing API Credential
+
+# Look up an existing API Credential by name
+data "f5xc_api_credential" "example" {
+  name      = "example-api-credential"
+  namespace = "system"
+}
+
+# Example: Use the data source in another resource
+# output "api_credential_id" {
+#   value = data.f5xc_api_credential.example.id
+# }
+```
+
+<!-- schema generated by tfplugindocs -->
+## Argument Reference
+
+### Metadata Argument Reference
+
+<a id="name"></a>&#x2022; [`name`](#name) - Required String<br>Name of the APICredential
+
+<a id="namespace"></a>&#x2022; [`namespace`](#namespace) - Required String<br>Namespace where the APICredential exists
+
+### Attributes Reference
+
+In addition to all arguments above, the following attributes are exported:
+
+<a id="annotations"></a>&#x2022; [`annotations`](#annotations) - Optional Map<br>Annotations applied to this resource
+
+<a id="description"></a>&#x2022; [`description`](#description) - Optional String<br>Description of the APICredential
+
+<a id="id"></a>&#x2022; [`id`](#id) - Optional String<br>Unique identifier for the resource
+
+<a id="labels"></a>&#x2022; [`labels`](#labels) - Optional Map<br>Labels applied to this resource

package/dist/docs/data-sources/api_definition.md

@@ -0,0 +1,51 @@
+---
+page_title: "f5xc_api_definition Data Source - terraform-provider-f5xc"
+subcategory: "API Security"
+description: |-
+  [Category: API Security] [Namespace: required] [DependsOn: namespace] Manages API Definition. in F5 Distributed Cloud.
+---
+
+# f5xc_api_definition (Data Source)
+
+[Category: API Security] [Namespace: required] [DependsOn: namespace] Manages API Definition. in F5 Distributed Cloud.
+
+~> **Note** Please refer to [API Definition API docs](https://docs.cloud.f5.com/docs-v2/api/views-api-definition) to learn more.
+
+## Example Usage
+
+```terraform
+# API Definition Data Source Example
+# Retrieves information about an existing API Definition
+
+# Look up an existing API Definition by name
+data "f5xc_api_definition" "example" {
+  name      = "example-api-definition"
+  namespace = "system"
+}
+
+# Example: Use the data source in another resource
+# output "api_definition_id" {
+#   value = data.f5xc_api_definition.example.id
+# }
+```
+
+<!-- schema generated by tfplugindocs -->
+## Argument Reference
+
+### Metadata Argument Reference
+
+<a id="name"></a>&#x2022; [`name`](#name) - Required String<br>Name of the APIDefinition
+
+<a id="namespace"></a>&#x2022; [`namespace`](#namespace) - Required String<br>Namespace where the APIDefinition exists
+
+### Attributes Reference
+
+In addition to all arguments above, the following attributes are exported:
+
+<a id="annotations"></a>&#x2022; [`annotations`](#annotations) - Optional Map<br>Annotations applied to this resource
+
+<a id="description"></a>&#x2022; [`description`](#description) - Optional String<br>Description of the APIDefinition
+
+<a id="id"></a>&#x2022; [`id`](#id) - Optional String<br>Unique identifier for the resource
+
+<a id="labels"></a>&#x2022; [`labels`](#labels) - Optional Map<br>Labels applied to this resource