> For the complete documentation index, see [llms.txt](https://obsrv.sunbird.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://obsrv.sunbird.org/guides/connectors-developer-guide/required-files.md).

# Required Files

The SDK expects the following files to be as part of the source distribution:

* [**metadata.json**](/guides/connectors-developer-guide/required-files/metadata-json.md): This file is used mainly for registering a connector with the Obsrv system.
* [**ui-config.json**](/guides/connectors-developer-guide/required-files/ui-config-json.md): This JSON configuration schema is used to define the data that the user interface (UI) will collect from the user to configure the connector.
* [**metrics.yaml**](/guides/connectors-developer-guide/required-files/metrics.yaml.md): This YAML configuration is used to define metrics for monitoring and reporting purposes in the system.
* [**alerts.yaml**](/guides/connectors-developer-guide/required-files/alerts.yaml.md): This file contains the alert configuration, which will be converted into a Prometheus expression used to create the alert.


---

# 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://obsrv.sunbird.org/guides/connectors-developer-guide/required-files.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.