Skip to main content
The MCP server exposes three kinds of tools: documentation search, the JobMojito API (auto-generated from the OpenAPI spec, 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 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

ToolPurpose
search_documentationSearch developer docs + help center in parallel.
get_documentationFetch a documentation page by URL.

Configuration / merchants

ToolPurpose
jobmojito_configurationInteractive, searchable merchant picker (UI clients). Run it whenever a merchant_id is needed but none is selected.
list_my_merchantsText 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.

Interview — create & manage

ToolEndpointPurpose
create_interviewPOST /job-interview-createCreate an interview with AI-generated questions from a job description.
create_interview_from_questionsPOST /job-interview-create-from-arrayCreate an interview from your own array of questions.
get_interview_definitionPOST /job-interview-getFetch an interview’s definition/configuration.
set_interview_statePOST /job-interview-set-stateChange lifecycle state / manage the iframe embed key.
generate_interview_urlPOST /job-interview-tokenGenerate a signed public interview URL.
request_another_interview_attemptPOST /job-interview-result-request-another-attemptRe-open a submitted result so the candidate can retry.
register_users_for_interviewPOST /job-interview-register-usersRegister candidates for an interview and get their links (batch, per-row results).

Results & reports

ToolEndpointPurpose
get_interview_result_detailsPOST /job-interview-detailsFull result with transcript and AI analysis.
generate_interview_reportPOST /job-interview-pdfGenerate an HTML / PDF / JSON report for a completed interview.

Knowledge base

ToolEndpointPurpose
upload_knowledge_base_documentPOST /knowledge-base-document-uploadUpload a document the AI can draw questions/context from.

Merchant lists (read-only)

ToolPurpose
list_interviewsList the merchant’s interview definitions.
list_candidatesList candidates.
list_interview_resultsList interview results.
list_avatarsList available interviewer avatars.
list_sub_merchantsList sub-merchants you manage.
get_merchant_analyticsFetch merchant daily event analytics.
get_merchant_statusStatus snapshot: credit balances, subscription, pending-work counts, candidate/result totals, and invitation headroom.
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 is the source of truth for request/response schemas.

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