> ## Documentation Index
> Fetch the complete documentation index at: https://developer.jobmojito.com/llms.txt
> Use this file to discover all available pages before exploring further.

# MCP tools reference

> The JobMojito MCP tool inventory by category, how to build admin UI deep-links, and the docs-first calling pattern agents should follow.

The MCP server exposes three kinds of tools: **documentation search**, the **JobMojito API** (auto-generated from the [OpenAPI spec](/how-the-api-works), one tool per endpoint with a curated name), and **merchant selection**. Tool descriptions are prefixed with a `[Category]` label so agents can group them.

## Docs-first calling pattern

The server's instructions ask agents to **understand before acting**:

1. To learn how an endpoint, field, or workflow behaves, call `search_documentation` **first**, then `get_documentation(url)` to read the page — don't call action tools speculatively just to discover their inputs.
2. `search_documentation` is a single entry point: one call searches both this developer/API reference and the [help center](https://help.jobmojito.com) in parallel.
3. For multi-step work, search for a step-by-step cookbook and follow it rather than chaining tools by trial and error.
4. Prefer the read-only **list** tools to look things up before creating or changing anything.

## Documentation

| Tool                   | Purpose                                          |
| ---------------------- | ------------------------------------------------ |
| `search_documentation` | Search developer docs + help center in parallel. |
| `get_documentation`    | Fetch a documentation page by URL.               |

## Configuration / merchants

| Tool                      | Purpose                                                                                                               |
| ------------------------- | --------------------------------------------------------------------------------------------------------------------- |
| `jobmojito_configuration` | Interactive, searchable merchant picker (UI clients). Run it whenever a `merchant_id` is needed but none is selected. |
| `list_my_merchants`       | Text list of your merchants (supports a `search` filter) — the fallback for non-UI clients.                           |

Pass the chosen `merchant_id` on subsequent calls; omit it to act on your own account. See [Merchant scoping](/mcp/overview#merchant-scoping).

## Interview — create & manage

| Tool                                | Endpoint                                             | Purpose                                                                            |
| ----------------------------------- | ---------------------------------------------------- | ---------------------------------------------------------------------------------- |
| `create_interview`                  | `POST /job-interview-create`                         | Create an interview with AI-generated questions from a job description.            |
| `create_interview_from_questions`   | `POST /job-interview-create-from-array`              | Create an interview from your own array of questions.                              |
| `get_interview_definition`          | `POST /job-interview-get`                            | Fetch an interview's definition/configuration.                                     |
| `set_interview_state`               | `POST /job-interview-set-state`                      | Change lifecycle state / manage the iframe embed key.                              |
| `generate_interview_url`            | `POST /job-interview-token`                          | Generate a signed public interview URL.                                            |
| `request_another_interview_attempt` | `POST /job-interview-result-request-another-attempt` | Re-open a submitted result so the candidate can retry.                             |
| `register_users_for_interview`      | `POST /job-interview-register-users`                 | Register candidates for an interview and get their links (batch, per-row results). |

## Results & reports

| Tool                           | Endpoint                      | Purpose                                                         |
| ------------------------------ | ----------------------------- | --------------------------------------------------------------- |
| `get_interview_result_details` | `POST /job-interview-details` | Full result with transcript and AI analysis.                    |
| `generate_interview_report`    | `POST /job-interview-pdf`     | Generate an HTML / PDF / JSON report for a completed interview. |

## Knowledge base

| Tool                             | Endpoint                               | Purpose                                                   |
| -------------------------------- | -------------------------------------- | --------------------------------------------------------- |
| `upload_knowledge_base_document` | `POST /knowledge-base-document-upload` | Upload a document the AI can draw questions/context from. |

## Merchant lists (read-only)

| Tool                     | Purpose                                                                                                                |
| ------------------------ | ---------------------------------------------------------------------------------------------------------------------- |
| `list_interviews`        | List the merchant's interview definitions.                                                                             |
| `list_candidates`        | List candidates.                                                                                                       |
| `list_interview_results` | List interview results.                                                                                                |
| `list_avatars`           | List available interviewer avatars.                                                                                    |
| `list_sub_merchants`     | List sub-merchants you manage.                                                                                         |
| `get_merchant_analytics` | Fetch merchant daily event analytics.                                                                                  |
| `get_merchant_status`    | Status snapshot: credit balances, subscription, pending-work counts, candidate/result totals, and invitation headroom. |

<Note>
  New JobMojito endpoints appear as tools automatically (with an auto-generated name) even before they're curated here, so this table can lag slightly behind the live tool list. The [API Reference](/how-the-api-works) is the source of truth for request/response schemas.
</Note>

### Not exposed as MCP tools

A few endpoints are intentionally **excluded** from the MCP surface (they're administrative or one-shot flows not suited to general agent use) but remain fully available over the [HTTP API](/how-the-api-works): bulk `invite-users`, `create-for-candidate-with-token`, and the pre-screening endpoints (`pre-screening-create`, resume text/binary pre-screen). Call these directly with a bearer token when you need them.

## Identifiers & admin links

Which id goes in which field is the most common source of errors — and the same interview id is named `interview_def_set_id`, `position_id`, or `interview_id` depending on the endpoint. See [**Identifiers & admin links**](/mcp/identifiers) for the full id glossary, the "same id, different field name" tables, the admin app link patterns, and how to resolve an id from a name. The MCP server's own instructions point agents at that guide before they pass an unfamiliar id.
