> For the complete documentation index, see [llms.txt](https://docs.opshub.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.opshub.com/v7.226/manage/mcp/mcp-sample-use-cases/mcp-use-case-integration-healthcheck.md).

# Integration Health Monitoring

### Description

To get a complete picture of <code class="expression">space.vars.OIM</code> instance — not just whether integrations are running, but also the machine's memory consumption, disk space, database connection usage, active threads, and whether there are any unresolved failures that need attention. All of this without opening the UI.

### Example interaction

| Component               | Detail                                                                                                                                                                                                                                             |
| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **User prompt**         | "Give me a full health check of my OIM instance — I want to know the resource usage, how integrations are doing, and if there are any failures I should be worried about."                                                                         |
| **MCP tools invoked**   | `health_checkup_planner` → `get_oim_system_information` → `get_integrations_list` → `get_systems_list` → `get_processing_failures_list` → `get_global_failures_list` → `get_mappings_list`                                                         |
| **AI assistant steps**  | Fetches instance resource data (RAM allocation, memory used, disk space, DB connections, HTTP threads) → retrieves integrations with entity pair execution statuses, last sync times, and failure counts → retrieves and groups failures by cause. |
| **AI assistant output** | A health dashboard with overall status (HEALTHY / WARNING / CRITICAL), resource summary, integration and failure summaries, and prioritised recommendations.                                                                                       |

### Notes

* You can scope the check to specific systems: *"Health check for integrations between Jira and Rally."*
* To avoid stale results from a previous query in the same session, include "Do not use previously fetched data" in your prompt.


---

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

```
GET https://docs.opshub.com/v7.226/manage/mcp/mcp-sample-use-cases/mcp-use-case-integration-healthcheck.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.
