@robinmordasiewicz/f5xc-terraform-mcp 2.14.10 → 2.15.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 MCP Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,346 +1,153 @@
-# F5 Distributed Cloud Terraform Provider MCP Server
+# MCP Registry
 
-A Model Context Protocol (MCP) server that provides AI assistants with comprehensive access to the F5 Distributed Cloud (F5XC) Terraform provider documentation and OpenAPI specifications.
+The MCP registry provides MCP clients with a list of MCP servers, like an app store for MCP servers.
 
-## Features
+[**📤 Publish my MCP server**](docs/modelcontextprotocol-io/quickstart.mdx) | [**⚡️ Live API docs**](https://registry.modelcontextprotocol.io/docs) | [**👀 Ecosystem vision**](docs/design/ecosystem-vision.md) | 📖 **[Full documentation](./docs)**
 
-- **144+ Resource Documentation**: Complete Terraform resource docs with arguments, attributes, and examples
-- **270+ OpenAPI Specifications**: Full F5XC API specifications for all services
-- **Intelligent Search**: Search across documentation and API specs with relevance scoring
-- **Schema Exploration**: Browse and query API schema definitions
-- **Endpoint Discovery**: Find API endpoints by pattern across all specifications
+## Development Status
 
-## Installation
+**2025-10-24 update**: The Registry API has entered an **API freeze (v0.1)** 🎉. For the next month or more, the API will remain stable with no breaking changes, allowing integrators to confidently implement support. This freeze applies to v0.1 while development continues on v0. We'll use this period to validate the API in real-world integrations and gather feedback to shape v1 for general availability. Thank you to everyone for your contributions and patience—your involvement has been key to getting us here!
 
-Choose the installation method that best fits your environment:
+**2025-09-08 update**: The registry has launched in preview 🎉 ([announcement blog post](https://blog.modelcontextprotocol.io/posts/2025-09-08-mcp-registry-preview/)). While the system is now more stable, this is still a preview release and breaking changes or data resets may occur. A general availability (GA) release will follow later. We'd love your feedback in [GitHub discussions](https://github.com/modelcontextprotocol/registry/discussions/new?category=ideas) or in the [#registry-dev Discord](https://discord.com/channels/1358869848138059966/1369487942862504016) ([joining details here](https://modelcontextprotocol.io/community/communication)).
 
-| Method | Best For | Requirements |
-|--------|----------|--------------|
-| [VSCode MCP Gallery](#vscode-mcp-gallery) | VSCode users (easiest) | VSCode 1.99+ |
-| [npx (Recommended)](#from-npm) | Developers with Node.js | Node.js 18+ |
-| [MCPB Bundle](#mcpb-bundle-no-nodejs-required) | Corporate laptops (no Node.js) | None |
-| [From Source](#from-source) | Contributors | Node.js 18+, npm |
+Current key maintainers:
+- **Adam Jones** (Anthropic) [@domdomegg](https://github.com/domdomegg)  
+- **Tadas Antanavicius** (PulseMCP) [@tadasant](https://github.com/tadasant)
+- **Toby Padilla** (GitHub) [@toby](https://github.com/toby)
+- **Radoslav (Rado) Dimitrov** (Stacklok) [@rdimitrov](https://github.com/rdimitrov)
 
-### VSCode MCP Gallery
+## Contributing
 
-The easiest way to install for VSCode users. Choose from multiple options:
+We use multiple channels for collaboration - see [modelcontextprotocol.io/community/communication](https://modelcontextprotocol.io/community/communication).
 
-**Option A: MCP Gallery Search (Recommended for VSCode 1.105+)**
+Often (but not always) ideas flow through this pipeline:
 
-1. Open VSCode
-2. Open the Extensions view (`Ctrl+Shift+X` / `Cmd+Shift+X`)
-3. Type `@MCP` in the search box to filter MCP servers
-4. Search for `f5xc` or `F5 Distributed Cloud`
-5. Click **Install**
+- **[Discord](https://modelcontextprotocol.io/community/communication)** - Real-time community discussions
+- **[Discussions](https://github.com/modelcontextprotocol/registry/discussions)** - Propose and discuss product/technical requirements
+- **[Issues](https://github.com/modelcontextprotocol/registry/issues)** - Track well-scoped technical work  
+- **[Pull Requests](https://github.com/modelcontextprotocol/registry/pulls)** - Contribute work towards issues
 
-**Option B: Command Palette**
+### Quick start:
 
-1. Open VSCode
-2. Press `Ctrl+Shift+P` / `Cmd+Shift+P` to open Command Palette
-3. Run `MCP: Add Server`
-4. Select `npm package`
-5. Enter: `@robinmordasiewicz/f5xc-terraform-mcp`
-6. Choose scope: **Global** (all workspaces) or **Workspace** (this project only)
+#### Pre-requisites
 
-### From npm
+- **Docker**
+- **Go 1.24.x**
+- **ko** - Container image builder for Go ([installation instructions](https://ko.build/install/))
+- **golangci-lint v2.4.0**
 
-```bash
-npm install -g @robinmordasiewicz/f5xc-terraform-mcp
-```
-
-Or run directly with npx (no installation required):
+#### Running the server
 
 ```bash
-npx @robinmordasiewicz/f5xc-terraform-mcp
+# Start full development environment
+make dev-compose
 ```
 
-### MCPB Bundle (No Node.js Required)
-
-For corporate environments where Node.js cannot be installed. The MCPB bundle is fully self-contained with all dependencies included.
+This starts the registry at [`localhost:8080`](http://localhost:8080) with PostgreSQL. The database uses ephemeral storage and is reset each time you restart the containers, ensuring a clean state for development and testing.
 
-**For VSCode:**
+**Note:** The registry uses [ko](https://ko.build) to build container images. The `make dev-compose` command automatically builds the registry image with ko and loads it into your local Docker daemon before starting the services.
 
-1. Download the latest `.mcpb` file from [GitHub Releases](https://github.com/robinmordasiewicz/terraform-provider-f5xc/releases)
-2. In VSCode, press `Ctrl+Shift+P` / `Cmd+Shift+P`
-3. Run `MCP: Add Server`
-4. Drag and drop the `.mcpb` file, or select it when prompted
-5. Run `MCP: List Servers` to verify installation
+By default, the registry seeds from the production API with a filtered subset of servers (to keep startup fast). This ensures your local environment mirrors production behavior and all seed data passes validation. For offline development you can seed from a file without validation with `MCP_REGISTRY_SEED_FROM=data/seed.json MCP_REGISTRY_ENABLE_REGISTRY_VALIDATION=false make dev-compose`.
 
-**For Claude Desktop:**
+The setup can be configured with environment variables in [docker-compose.yml](./docker-compose.yml) - see [.env.example](./.env.example) for a reference.
 
-1. Download the latest `.mcpb` file from [GitHub Releases](https://github.com/robinmordasiewicz/terraform-provider-f5xc/releases)
-2. Double-click the file to install, or drag it into Claude Desktop
-3. Restart Claude Desktop to activate
+<details>
+<summary>Alternative: Running a pre-built Docker image</summary>
 
-**File**: `f5xc-terraform-mcp-X.Y.Z.mcpb`
-
-> **Note:** MCPB bundles are automatically built and attached to each GitHub Release. No npm or Node.js installation is required. The bundle includes a self-contained Node.js runtime.
-
-### From Source
+Pre-built Docker images are automatically published to GitHub Container Registry:
 
 ```bash
-cd mcp-server
-npm install
-npm run build
-```
-
-## Configuration
-
-### Claude Desktop
+# Run latest stable release
+docker run -p 8080:8080 ghcr.io/modelcontextprotocol/registry:latest
 
-Add to your Claude Desktop configuration (`~/Library/Application Support/Claude/claude_desktop_config.json` on macOS):
+# Run latest from main branch (continuous deployment)
+docker run -p 8080:8080 ghcr.io/modelcontextprotocol/registry:main
 
-```json
-{
-  "mcpServers": {
-    "f5xc-terraform": {
-      "command": "npx",
-      "args": ["-y", "@robinmordasiewicz/f5xc-terraform-mcp"]
-    }
-  }
-}
-```
+# Run specific release version
+docker run -p 8080:8080 ghcr.io/modelcontextprotocol/registry:v1.0.0
 
-Or if running from source:
-
-```json
-{
-  "mcpServers": {
-    "f5xc": {
-      "command": "node",
-      "args": ["/path/to/terraform-provider-f5xc/mcp-server/dist/index.js"]
-    }
-  }
-}
+# Run development build from main branch
+docker run -p 8080:8080 ghcr.io/modelcontextprotocol/registry:main-20250906-abc123d
 ```
 
-### Claude Code (CLI)
-
-Install the MCP server with a single command:
-
-```bash
-claude mcp add f5xc-terraform -- npx -y @robinmordasiewicz/f5xc-terraform-mcp
-```
+**Available tags:**
+- **Releases**: `latest`, `v1.0.0`, `v1.1.0`, etc.
+- **Continuous**: `main` (latest main branch build)
+- **Development**: `main-<date>-<sha>` (specific commit builds)
 
-**Scope Options:**
+</details>
 
-- `--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
+#### Publishing a server
 
-Examples with different scopes:
+To publish a server, we've built a simple CLI. You can use it with:
 
 ```bash
-# User-wide installation (recommended for personal use)
-claude mcp add --scope user f5xc-terraform -- npx -y @robinmordasiewicz/f5xc-terraform-mcp
+# Build the latest CLI
+make publisher
 
-# Project-specific installation (for team collaboration)
-claude mcp add --scope project f5xc-terraform -- npx -y @robinmordasiewicz/f5xc-terraform-mcp
+# Use it!
+./bin/mcp-publisher --help
 ```
 
-**Verify Installation:**
+See [the publisher guide](./docs/modelcontextprotocol-io/quickstart.mdx) for more details.
 
-```bash
-claude mcp list
-```
-
-You should see `f5xc-terraform` listed with a `✓ Connected` status.
-
-**Remove Server:**
+#### Other commands
 
 ```bash
-claude mcp remove f5xc-terraform
+# Run lint, unit tests and integration tests
+make check
 ```
 
-### 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"]
-      }
-    }
-  }
-}
-```
-
-**Verify VSCode Installation:**
-
-1. Press `Ctrl+Shift+P` / `Cmd+Shift+P`
-2. Run `MCP: List Servers`
-3. Look for `f5xc-terraform` with a green status indicator
-
-**Troubleshooting VSCode:**
-
-- **Server not appearing**: Restart VSCode after adding the server configuration
-- **Connection issues**: Check the Output panel (`View > Output`) and select "MCP" from the dropdown
-- **Node.js not found**: Use the [MCPB Bundle](#mcpb-bundle-no-nodejs-required) method instead
-
-## Available Tools
-
-### Documentation Tools
-
-| Tool | Description |
-|------|-------------|
-| `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_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 |
+There are also a few more helpful commands for development. Run `make help` to learn more, or look in [Makefile](./Makefile).
 
-### Subscription Tier Tools
-
-| Tool | Description |
-|------|-------------|
-| `f5xc_terraform_get_subscription_info` | Get subscription tier requirements for resources |
-| `f5xc_terraform_get_property_subscription_info` | Get property-level subscription tier indicators |
-
-### Addon Service Tools
-
-| Tool | Description |
-|------|-------------|
-| `f5xc_terraform_addon_list_services` | List available addon services with activation requirements |
-| `f5xc_terraform_addon_check_activation` | Check if an addon service is activated for the tenant |
-| `f5xc_terraform_addon_activation_workflow` | Get activation workflow and Terraform code for addons |
-
-### Utility Tools
-
-| Tool | Description |
-|------|-------------|
-| `f5xc_terraform_get_summary` | Get overview of all available docs and specs |
-
-## Usage Examples
-
-### Find HTTP Load Balancer Documentation
-
-```
-User: How do I configure an HTTP load balancer in F5XC with Terraform?
-
-Claude: [Uses f5xc_terraform_search_docs with query "http_loadbalancer"]
-        [Uses f5xc_terraform_get_doc with name "http_loadbalancer"]
-```
-
-### Discover API Endpoints
-
-```
-User: What API endpoints are available for managing namespaces?
-
-Claude: [Uses f5xc_terraform_find_endpoints with pattern "/namespaces"]
-```
-
-### Explore Schema Definitions
-
-```
-User: What fields are available in the app_firewall configuration?
-
-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
-
-### Build
-
-```bash
-npm run build
-```
-
-### Development Mode (with auto-reload)
-
-```bash
-npm run dev
-```
-
-### Type Check
-
-```bash
-npm run typecheck
-```
+<!--
+For Claude and other AI tools: Always prefer make targets over custom commands where possible.
+-->
 
 ## Architecture
 
+### Project Structure
+
 ```
-mcp-server/
-├── src/
-│   ├── index.ts          # MCP server entry point
-│   ├── types.ts          # TypeScript type definitions
-│   ├── schemas/          # Zod validation schemas
-│   │   └── index.ts
-│   └── services/         # Core services
-│       ├── documentation.ts   # Doc loading and search
-│       └── api-specs.ts       # OpenAPI spec handling
-├── package.json
-├── tsconfig.json
-└── README.md
+├── cmd/                     # Application entry points
+│   └── publisher/           # Server publishing tool
+├── data/                    # Seed data
+├── deploy/                  # Deployment configuration (Pulumi)
+├── docs/                    # Documentation
+├── internal/                # Private application code
+│   ├── api/                 # HTTP handlers and routing
+│   ├── auth/                # Authentication (GitHub OAuth, JWT, namespace blocking)
+│   ├── config/              # Configuration management
+│   ├── database/            # Data persistence (PostgreSQL)
+│   ├── service/             # Business logic
+│   ├── telemetry/           # Metrics and monitoring
+│   └── validators/          # Input validation
+├── pkg/                     # Public packages
+│   ├── api/                 # API types and structures
+│   │   └── v0/              # Version 0 API types
+│   └── model/               # Data models for server.json
+├── scripts/                 # Development and testing scripts
+├── tests/                   # Integration tests
+└── tools/                   # CLI tools and utilities
+    └── validate-*.sh        # Schema validation tools
 ```
 
-## Resources Served
-
-### Documentation Types
+### Authentication
 
-- **Resources**: Terraform resources (http_loadbalancer, origin_pool, namespace, etc.)
-- **Data Sources**: Terraform data sources for reading existing resources
-- **Functions**: Provider-defined functions (blindfold, blindfold_file)
-- **Guides**: Step-by-step tutorials and how-to guides
+Publishing supports multiple authentication methods:
+- **GitHub OAuth** - For publishing by logging into GitHub
+- **GitHub OIDC** - For publishing from GitHub Actions
+- **DNS verification** - For proving ownership of a domain and its subdomains
+- **HTTP verification** - For proving ownership of a domain
 
-### API Specifications
+The registry validates namespace ownership when publishing. E.g. to publish...:
+- `io.github.domdomegg/my-cool-mcp` you must login to GitHub as `domdomegg`, or be in a GitHub Action on domdomegg's repos
+- `me.adamjones/my-cool-mcp` you must prove ownership of `adamjones.me` via DNS or HTTP challenge
 
-All F5 Distributed Cloud public APIs including:
-- HTTP/TCP Load Balancers
-- Origin Pools
-- Application Firewalls (WAF)
-- Namespaces
-- DNS Management
-- Network Policies
-- Cloud Sites (AWS, Azure, GCP)
-- And 260+ more...
+## Community Projects
 
-## License
+Check out [community projects](docs/community-projects.md) to explore notable registry-related work created by the community.
 
-MIT
-
-## Contributing
+## More documentation
 
-Contributions welcome! Please see the main [terraform-provider-f5xc](https://github.com/robinmordasiewicz/terraform-provider-f5xc) repository for contribution guidelines.
+See the [documentation](./docs) for more details if your question has not been answered here!

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

@@ -2,12 +2,12 @@
 page_title: "f5xc_dns_zone Data Source - terraform-provider-f5xc"
 subcategory: "DNS"
 description: |-
-  Manages DNS Zone in a given namespace. If one already exist it will give a error. in F5 Distributed Cloud.
+  Manages a DNS Zone resource in F5 Distributed Cloud.
 ---
 
 # f5xc_dns_zone (Data Source)
 
-Manages DNS Zone in a given namespace. If one already exist it will give a error. in F5 Distributed Cloud.
+Manages a DNS Zone resource in F5 Distributed Cloud.
 
 ~> **Note** Please refer to [DNS Zone API docs](https://docs.cloud.f5.com/docs-v2/api/dns-zone) to learn more.
 

package/dist/docs/resources/api_credential.md

@@ -49,8 +49,6 @@ resource "f5xc_api_credential" "example" {
 
 <a id="name"></a>&#x2022; [`name`](#name) - Required String<br>Name of the API Credential. Must be unique within the namespace
 
-<a id="namespace"></a>&#x2022; [`namespace`](#namespace) - Required String<br>Namespace where the API Credential will be created
-
 <a id="annotations"></a>&#x2022; [`annotations`](#annotations) - Optional Map<br>Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata
 
 <a id="description"></a>&#x2022; [`description`](#description) - Optional String<br>Human readable description for the object
@@ -59,6 +57,8 @@ resource "f5xc_api_credential" "example" {
 
 <a id="labels"></a>&#x2022; [`labels`](#labels) - Optional Map<br>Labels is a user defined key value map that can be attached to resources for organization and filtering
 
+<a id="namespace"></a>&#x2022; [`namespace`](#namespace) - Optional String<br>Namespace for the API Credential. For this resource type, namespace should be empty or omitted
+
 ### Spec Argument Reference
 
 <a id="password"></a>&#x2022; [`password`](#password) - Optional String<br>Password. Password is used for generating an API certificate P12 bundle user can use to protect access to it. this password will not be saved/persisted anywhere in the system. Applicable for credential type API_CERTIFICATE Users have to use this password when they use the certificate, e.g. in curl or while adding to key chain

package/dist/docs/resources/child_tenant.md

@@ -54,6 +54,8 @@ resource "f5xc_child_tenant" "example" {
 
 <a id="name"></a>&#x2022; [`name`](#name) - Required String<br>Name of the Child Tenant. Must be unique within the namespace
 
+<a id="namespace"></a>&#x2022; [`namespace`](#namespace) - Required String<br>Namespace where the Child Tenant will be created
+
 <a id="annotations"></a>&#x2022; [`annotations`](#annotations) - Optional Map<br>Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata
 
 <a id="description"></a>&#x2022; [`description`](#description) - Optional String<br>Human readable description for the object
@@ -62,8 +64,6 @@ resource "f5xc_child_tenant" "example" {
 
 <a id="labels"></a>&#x2022; [`labels`](#labels) - Optional Map<br>Labels is a user defined key value map that can be attached to resources for organization and filtering
 
-<a id="namespace"></a>&#x2022; [`namespace`](#namespace) - Optional String<br>Namespace for the Child Tenant. For this resource type, namespace should be empty or omitted
-
 ### Spec Argument Reference
 
 <a id="child-tenant-manager"></a>&#x2022; [`child_tenant_manager`](#child-tenant-manager) - Optional Block<br>Object reference. This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name<br>See [Child Tenant Manager](#child-tenant-manager) below for details.