# Toolkit

The toolkit is the primary dependency for building OpenCRVS country configurations. It exposes typed builders and helpers for defining events, forms, conditional logic, deduplication rules, and advanced search.

The toolkit version must match your OpenCRVS Core version exactly. If you are running OpenCRVS 2.0.0, install `@opencrvs/toolkit@2.0.0`.

```bash
npm install @opencrvs/toolkit@2.0.0
```

When upgrading OpenCRVS to a new version, upgrading the toolkit first is a good starting point. Type errors and breaking changes in your country configuration surface immediately at compile time, so you can address any required configuration updates before deploying.


---

# Agent Instructions: 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:

```
GET https://documentation.opencrvs.org/v2.0/technical/apis/toolkit.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
