feat: template for rhdh to automatically discover MCP servers

.pre-commit-config.yaml

@@ -5,6 +5,16 @@ repos:
     hooks:
       - id: update-docs
 
+  - repo: local
+    hooks:
+      - id: generate-templates
+        name: (Re)generate Portal Templates
+        entry: ansible-playbook generate_template.yaml
+        language: python
+        pass_filenames: false
+        additional_dependencies:
+          - ansible-core
+
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v6.0.0
     hooks:

.prettierignore

@@ -1,6 +1,7 @@
 # files we don't want prettier to ever to look into
 .*/
 coverage/
+extensions/mcp
 
 # Environments
 .env

changelogs/fragments/minor_add_server_template.yaml

@@ -0,0 +1,3 @@
+---
+minor_changes:
+  - Add playbook to generate template files based off role defaults for other tools to know what MCP servers a collection supports.

extensions/mcp/servers.yaml

@@ -0,0 +1,17 @@
+---
+- name: github_mcp
+  servers:
+    - repository:
+        name: github-mcp-server
+        type: stdio
+        lang: go
+        args: ['stdio']
+        description: GitHub MCP Server - Access GitHub repositories, issues, and pull requests
+- name: aws_iam_mcp
+  servers:
+    - repository:
+        name: awslabs.iam-mcp-server
+        type: stdio
+        lang: pypi
+        args: []
+        description: An MCP server for comprehensive AWS Identity and Access Management (IAM) operations.

generate_template.yaml

@@ -0,0 +1,55 @@
+# vi: ft=yaml.ansible
+---
+- name: Generate portal template files
+  hosts: localhost
+  connection: local
+  gather_facts: false
+
+  tasks:
+    - name: Collect roles
+      ansible.builtin.find:
+        file_type: directory
+        paths:
+          - "{{ playbook_dir }}/roles"
+      register: role_paths
+
+    - name: Set role names
+      ansible.builtin.set_fact:
+        mcp_roles: "{{ role_paths.files | map(attribute='path') | map('basename') }}"
+        mcp_extension_dir: "{{ playbook_dir }}/extensions/mcp"
+
+    - name: Create noop task file
+      ansible.builtin.copy:
+        content: "---\n# Do nothing\n"
+        dest: "roles/{{ item }}/tasks/noop.yaml"
+        mode: "0644"
+      loop: "{{ mcp_roles }}"
+
+    - name: Load MCP roles to gain access to defaults
+      ansible.builtin.include_role:
+        name: "{{ item }}"
+        tasks_from: noop
+        public: true
+      loop: "{{ mcp_roles }}"
+
+    - name: Zip registry with details
+      ansible.builtin.set_fact:
+        registries: >-
+          {{ registries | default([]) | union([{
+            'name': item,
+            'registry': lookup('vars', item + '_registry', default=[]),
+          }]) }}
+      loop: "{{ mcp_roles }}"
+
+    - name: Create destination directory
+      ansible.builtin.file:
+        dest: "{{ mcp_extension_dir }}"
+        state: directory
+        mode: "0755"
+
+    - name: Template each registry
+      ansible.builtin.template:
+        src: server.yaml.j2
+        dest: "{{ mcp_extension_dir }}/servers.yaml"
+        mode: "0644"
+        lstrip_blocks: true

templates/server.yaml.j2

@@ -0,0 +1,11 @@
+---
+{% for registry in registries if registry.registry %}
+- name: {{ registry.name }}
+  servers:
+  {% for server in registry.registry %}
+    - repository:
+        {% for key, value in server.items() %}
+        {{key}}: {{ value }}
+        {% endfor %}
+  {% endfor %}
+{% endfor %}