> For the complete documentation index, see [llms.txt](https://docs.balkan.id/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.balkan.id/balkanid-mcp/tools-reference.md).

# Tools Reference

### Overview

BalkanID MCP exposes BalkanID capabilities as tools your AI assistant can call.

{% hint style="info" %}
Tool availability depends on your scopes and role. For an in-session list tailored to your connection, ask the assistant to call **`help`**.
{% endhint %}

### How to read Access

Each tool shows compact access chips:

* **Scope** — `Read` or `Write` (API key / connection scope required)
* **Min. role** — lowest BalkanID role that can use the tool (`Reviewer+`, `Risk Manager+`, or `Administrator`). Higher roles in the hierarchy inherit access.

OAuth sessions currently receive both Read and Write — see [Authentication and Permissions](/balkanid-mcp/authentication-and-permissions.md).

### Utility

| Tool     | Access               | Description                                                                               |
| -------- | -------------------- | ----------------------------------------------------------------------------------------- |
| `whoami` | `Read` · `Reviewer+` | Returns the current authenticated user email and tenant ID. Use to verify the connection. |
| `help`   | `Read` · `Reviewer+` | Returns a server overview, available tools, usage examples, and service health.           |

### Documentation

These tools search and read [BalkanID product documentation](https://docs.balkan.id) (proxied from GitBook). Use them when you need setup steps, feature behavior, or troubleshooting without leaving the chat.

| Tool                       | Access                | Description                                                                               |
| -------------------------- | --------------------- | ----------------------------------------------------------------------------------------- |
| `docs_askQuestion`         | `Read` · `Reviewer+`  | Ask a natural-language question; returns a synthesized answer with links to source pages. |
| `docs_searchDocumentation` | `Read` · `Reviewer+`  | Search published docs for matching pages and excerpts.                                    |
| `docs_getPage`             | `Read` · `Reviewer+`  | Fetch full markdown for a docs page URL (for example from search results).                |
| `docs_sendFeedback`        | `Write` · `Reviewer+` | Report a documentation issue or suggestion to the BalkanID docs team.                     |

### Discovery

<table data-search="false"><thead><tr><th>Tool</th><th>Access</th><th>Description</th></tr></thead><tbody><tr><td><code>list_integrations</code></td><td><code>Read</code> · <code>Reviewer+</code></td><td>Lists integration instances. Defaults to <strong>active</strong> status unless you pass another status.</td></tr><tr><td><code>sync_integration</code></td><td><code>Write</code> · <code>Administrator</code></td><td>Triggers a data sync for an integration.</td></tr><tr><td><code>list_identities</code></td><td><code>Read</code> · <code>Reviewer+</code></td><td>Lists identities (users, bots, service accounts) across connected apps. Supports rich filtering and pagination.</td></tr><tr><td><code>list_connections</code></td><td><code>Read</code> · <code>Reviewer+</code></td><td>Lists connections (roles, groups, permission sets).</td></tr><tr><td><code>list_resources</code></td><td><code>Read</code> · <code>Reviewer+</code></td><td>Lists resources (repos, channels, projects, and similar).</td></tr><tr><td><code>list_credentials</code></td><td><code>Read</code> · <code>Reviewer+</code></td><td>Lists credentials (API keys, tokens, service account keys). Filter by type, status, owner, app, or integration.</td></tr><tr><td><code>list_entity_relations</code></td><td><code>Read</code> · <code>Reviewer+</code></td><td>Lists directed relationships between entities (for example identity → connection, identity → credential, credential → resource).</td></tr><tr><td><code>filter_dimension_options</code></td><td><code>Read</code> · <code>Reviewer+</code></td><td>Returns distinct filter values for a field (for example departments or apps).</td></tr></tbody></table>

### Employees

| Tool              | Access                    | Description                                                      |
| ----------------- | ------------------------- | ---------------------------------------------------------------- |
| `list_employees`  | `Read` · `Reviewer+`      | Lists HR employee records with optional filters.                 |
| `create_employee` | `Write` · `Administrator` | Creates a new employee (or updates if the email already exists). |
| `edit_employee`   | `Write` · `Administrator` | Updates an existing employee by email.                           |

### User access reviews

| Tool                           | Access                   | Description                                                           |
| ------------------------------ | ------------------------ | --------------------------------------------------------------------- |
| `list_campaigns`               | `Read` · `Risk Manager+` | Lists user access review / certification campaigns.                   |
| `list_campaign_access_reviews` | `Read` · `Reviewer+`     | Lists review items within a campaign.                                 |
| `list_request_access_reviews`  | `Read` · `Reviewer+`     | Lists review items within an access request.                          |
| `approve_reviews`              | `Write` · `Reviewer+`    | Approves one or more reviews by review ID. Optional reason for audit. |
| `reject_reviews`               | `Write` · `Reviewer+`    | Rejects one or more reviews by review ID. Optional reason for audit.  |
| `delegate_reviews`             | `Write` · `Reviewer+`    | Delegates reviews to another reviewer by email.                       |

### Access requests (lifecycle)

| Tool                  | Access                | Description                                                  |
| --------------------- | --------------------- | ------------------------------------------------------------ |
| `list_requests`       | `Read` · `Reviewer+`  | Lists access requests with optional filters.                 |
| `get_request_details` | `Read` · `Reviewer+`  | Returns full detail for a request, including review history. |
| `approve_request`     | `Write` · `Reviewer+` | Approves all reviews for a request.                          |
| `reject_request`      | `Write` · `Reviewer+` | Rejects all reviews for a request.                           |
| `delegate_request`    | `Write` · `Reviewer+` | Delegates a request’s reviews to another employee.           |

### JITPBAC — Purposes

| Tool                             | Access                | Description                                                       |
| -------------------------------- | --------------------- | ----------------------------------------------------------------- |
| `list_purposes`                  | `Read` · `Reviewer+`  | Lists Purposes (structured entitlement bundles).                  |
| `get_purpose_details`            | `Read` · `Reviewer+`  | Returns full Purpose detail, including integrations and entities. |
| `create_purpose_request`         | `Write` · `Reviewer+` | Creates an access request for a Purpose for an employee.          |
| `assign_employee_to_purpose`     | `Write` · `Reviewer+` | Assigns the current user to a Purpose (requires eligibility).     |
| `unassign_employee_from_purpose` | `Write` · `Reviewer+` | Removes the current user’s assignment from a Purpose.             |

### JITPBAC — Constraints

Constraints are **denial policies**: employees in scope must not access entities in scope. They are enforced when someone requests a Purpose that includes a constrained entity. See Constraints.

| Tool                | Access                    | Description                       |
| ------------------- | ------------------------- | --------------------------------- |
| `list_constraints`  | `Read` · `Reviewer+`      | Lists Constraints for the tenant. |
| `create_constraint` | `Write` · `Risk Manager+` | Creates a Constraint.             |
| `update_constraint` | `Write` · `Risk Manager+` | Updates an existing Constraint.   |
| `delete_constraint` | `Write` · `Risk Manager+` | Deletes a Constraint.             |


---

# 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://docs.balkan.id/balkanid-mcp/tools-reference.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.