> For the complete documentation index, see [llms.txt](https://cortex-docs.paloaltonetworks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cortex-docs.paloaltonetworks.com/cortex-xsiam-developer-guide/cortex-xsiam-development-guide/integrations-and-scripts/components/integration-description-file.md).

# Integration description file

The integration description file provides the supported integration use cases, and helps Cortex XSIAM users to easily configure an integration instance.

{% hint style="info" %}

### Tip

* Give as much information as you think the user needs to succeed, including permission levels, credentials, and keys.
* If there are permissions required on the integration level, list them.
* If commands have separate permissions, mention that, but document the required permission on the command level.
* [Images](/cortex-xsiam-developer-guide/cortex-xsiam-development-guide/documentation/images-in-documentation.md) can be added to integration description files.
  {% endhint %}

**Common use cases**

* How to get credentials
* How to get API Key/secret
* How to get Application ID

**Integration description file location**

The description file should be placed with the rest of the integration's files.

For example, if the pack name is **HelloWorld** and the integration name is also **HelloWorld**, the description file path is:

`~/.../content/Packs/HelloWorld/Integrations/HelloWorld/HelloWorld_description.md`

**Integration description file data**

The description file contains details on how to configure an integration instance, together with the relevant details needed from the product that are important for configuration. The file content can include troubleshooting tips and advanced details for different configuration cases.

{% hint style="info" %}

### Note

This file should not be confused with the integration [README file](/cortex-xsiam-developer-guide/cortex-xsiam-development-guide/documentation/readme-files-for-content-entities.md).
{% endhint %}

**Example**

This is the content of the HelloWorld\_description.md file:

```programlisting
## Hello World
- This section explains how to configure the instance of HelloWorld in Cortex XSIAM.
- You can use the following API Key: `43ea9b2d-4998-43a6-ae91-aba62a26868c`
```

**Integration description file content in the UI**

The content of the description file is displayed in the **Help** tab next to the integration instance settings configurations:

![](/files/j5dip7wsfBaGO2dUXYR2)

**Support level header YML metadata key**

The `supportlevelheader` key can be set to one of the following values to set the support level header in the content description:

* `xsoar` - The description specifies that Palo Alto Networks supports this integration.
* `partner` - The description specifies that this integration is partner supported and list the partner's contact information.
* `community` - The description specifies that this integration is community supported or lists the pack's author.

**Set the support level header YML metadata key**

To set the key, open the YAML file for the integration in the same folder where the description file is located and add the `supportlevelheader` key with of the supported values listed above.

If the key is not set in the integration YAML, the support level header is set to the `support` key in the `pack_metadata.json` file.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://cortex-docs.paloaltonetworks.com/cortex-xsiam-developer-guide/cortex-xsiam-development-guide/integrations-and-scripts/components/integration-description-file.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.