dx-search.md

name	description
dx-search	Searches the DX knowledge base. Activate when users type @dx in their prompt or mention PagoPA DX practices, pipelines or Terraform Modules.

DX Search Skill

This skill allows searching the PagoPA DX (Developer Experience) knowledge base for information about Azure infrastructure, naming conventions, policies, and other development practices.

Activation

Activate this skill when the user includes "@dx" in their prompt, followed by a search query or mentions topics related to PagoPA DX, such as:

• DX Terraform Modules
• DX Best Practices
• DX Naming conventions
• DX CI/CD pipelines
• DX Infrastructure best practices
• DX GitHub Actions workflows

Usage

1. Extract the search query from the user's message after "@dx".

2. Make a POST request to the DX search API:

   curl -X POST https://api.dev.dx.pagopa.it/search \
     -H "Content-Type: application/json" \
     -d '{
       "query": "<extracted_query>",
       "number_of_results": 5
     }'
   

3. Parse the JSON response and present the results to the user.

Response Format

The API returns a JSON object with:

• query: The search query
• results: Array of result objects, each containing:
  • content: The text content
  • score: Relevance score
  • source: URL of the source

Present the results in a readable format, showing the content snippets and sources.

DX Terraform Modules

When users inquire about DX Terraform Modules, obtain information about the available modules, their purposes, and links to their documentation.

You can obtain the list of DX Terraform Modules from the DX GitHub repository: https://github.com/pagopa/dx/tree/main/infra/modules

Or from the Terraform Registry under the pagopa-dx namespace: https://registry.terraform.io/v1/modules?namespace=pagopa-dx (json format)

DX Terraform Modules CHANGELOG location follow this pattern: https://github.com/pagopa/dx/blob/main/infra/modules//CHANGELOG.md

For example for the Azure GitHub Environment Bootstrap module: https://github.com/pagopa/dx/blob/main/infra/modules/azure_github_environment_bootstrap/CHANGELOG.md

You can also find module documentation on the Terraform Registry, for example: https://registry.terraform.io/modules/pagopa-dx/azure-github-environment-bootstrap

Consider including relevant module links in your responses when applicable and visit the links to verify the information is up to date.

Important: when asked for DX Terraform Module information, always refer to the latest versions of the modules. You can find the latest versions in the Terraform Registry and/or in the DX GitHub repository: https://github.com/pagopa/dx/tree/main/infra/modules

Example

User prompt: @dx Azure naming conventions

Extracted query: "Azure naming conventions"

API Call:

curl -X POST https://api.dev.dx.pagopa.it/search \
  -H "Content-Type: application/json" \
  -d '{
    "query": "Azure naming conventions",
    "number_of_results": 5
  }'

Sample Response:

{
  "query": "Azure naming conventions",
  "results": [
    {
      "content": "# Following Azure Naming Convention\nHaving a naming convention for your Azure resources is critical...",
      "score": 0.9862046241760254,
      "source": "https://dx.pagopa.it/docs/azure/azure-naming-convention"
    }
  ]
}

Present to user: Summarize the key points from the results, linking to sources.