Skip to main content
Glama

List document requests

list_document_requests
Read-onlyIdempotent

[Document requests] Documents asked from candidates: company-wide or for one candidate, by status, or attention=true for the ones that need a look (uploaded, overdue).

Every argument in full, with examples: get_tool_reference.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "list_document_requests"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoRequests per page (1 to 200, default 50).
offsetNoNumber of records to skip from the start of the result set.
statusNoOnly open, completed or cancelled requests.
attentionNotrue: only your own requests that need you (received or overdue), as To do > Today shows them.
llm_modelNoYour model id, e.g. "claude-opus-4-8"; "unknown" if unsure. For analytics.
merchant_idNoOptional merchant to scope to. Admins and sub-merchant operators only; other callers always use their token's merchant.
candidate_idNoOnly the requests of this candidate (the `id` of a list_candidates row).
conversation_idNoThe conversation_id this server returned earlier in this conversation, unchanged, including after later user messages. Omit it if you have none. Recorded for the server developer's analytics.

Output Schema

NameRequiredDescriptionDefault
dataYes
paginationYes
_mcp_instructionsNoServer-issued metadata for this conversation.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changed
    • changedInput schema / properties / attention / default
      Previous value: -"false"New value: +false
    • removedInput schema / properties / attention / enum
      Removed value: -[
      -  "true",
      -  "false"
      -]
    • changedInput schema / properties / attention / type
      Previous value: -"string"New value: +"boolean"
    • changedInput schema / properties / candidate_id / description
      Previous value: -"Only the requests of this candidate (profile_interview.id)."New value: +"Only the requests of this candidate (the `id` of a list_candidates row)."
  2. Changed42 schema fields changed
    • removedInput schema / properties / attention / example
      Removed value: -"false"
    • removedInput schema / properties / limit / example
      Removed value: -50
    • addedInput schema / properties / llm_model
      Added value: +{
      +  "description": "Your model id, e.g. \"claude-opus-4-8\"; \"unknown\" if unsure. For analytics.",
      +  "type": "string"
      +}
    • removedInput schema / properties / merchant_id / example
      Removed value: -"28106cba-1c27-4e53-b149-32113e5e8e31"
    • removedInput schema / properties / offset / example
      Removed value: -0
    • removedOutput schema / properties / data / description
      Removed value: -"Document requests of this page, newest first (attention: most recent event first)."
    • removedOutput schema / properties / data / items / properties / application_id / description
      Removed value: -"Application the request was made for (position_result.id)."
    • removedOutput schema / properties / data / items / properties / attention / description
      Removed value: -"Only with attention=true: received (completed, not yet reviewed) or overdue (open past the due date)."
    • removedOutput schema / properties / data / items / properties / cancelled_at / description
      Removed value: -"When it was cancelled (ISO 8601)."
    • removedOutput schema / properties / data / items / properties / candidate_id / description
      Removed value: -"Candidate asked (profile_interview.id)."
    • removedOutput schema / properties / data / items / properties / candidate_name / description
      Removed value: -"Candidate's name, or e-mail when the name is empty."
    • removedOutput schema / properties / data / items / properties / completed_at / description
      Removed value: -"When the last required document arrived (ISO 8601)."
    • removedOutput schema / properties / data / items / properties / created_at / description
      Removed value: -"When the request was made (ISO 8601)."
    • removedOutput schema / properties / data / items / properties / created_by_name / description
      Removed value: -"Who made it."
    • removedOutput schema / properties / data / items / properties / documents / description
      Removed value: -"The requested documents, in order."
    • removedOutput schema / properties / data / items / properties / documents / items / properties / description / description
      Removed value: -"Explanation shown to the candidate."
    • removedOutput schema / properties / data / items / properties / documents / items / properties / file_id / description
      Removed value: -"The uploaded file (interview_file.id)."
    • removedOutput schema / properties / data / items / properties / documents / items / properties / file_name / description
      Removed value: -"Name of the uploaded file."
    • removedOutput schema / properties / data / items / properties / documents / items / properties / id / description
      Removed value: -"Requested document id (profile_interview_document_request_item.id)."
    • removedOutput schema / properties / data / items / properties / documents / items / properties / required / description
      Removed value: -"The request completes when every required document is uploaded."
    • removedOutput schema / properties / data / items / properties / documents / items / properties / sequence_no / description
      Removed value: -"Order in the request, from 1."
    • removedOutput schema / properties / data / items / properties / documents / items / properties / source_field_id / description
      Removed value: -"The position's file question it came from: form_cover_letter, form_national_id or custom_<name>."
    • removedOutput schema / properties / data / items / properties / documents / items / properties / title / description
      Removed value: -"What was asked for."
    • removedOutput schema / properties / data / items / properties / documents / items / properties / uploaded_at / description
      Removed value: -"When the candidate uploaded it (ISO 8601). Left out while missing."
    • removedOutput schema / properties / data / items / properties / due_date / description
      Removed value: -"Due date (YYYY-MM-DD)."
    • removedOutput schema / properties / data / items / properties / id / description
      Removed value: -"Document request id (profile_interview_document_request.id)."
    • removedOutput schema / properties / data / items / properties / message / description
      Removed value: -"Message to the candidate."
    • removedOutput schema / properties / data / items / properties / notify / description
      Removed value: -"The candidate was e-mailed when the request was made (and is reminded once after the due date)."
    • removedOutput schema / properties / data / items / properties / overdue_reminded_at / description
      Removed value: -"When the candidate got the one reminder after the due date (ISO 8601)."
    • removedOutput schema / properties / data / items / properties / position_id / description
      Removed value: -"That application's position (position_def_set.id)."
    • removedOutput schema / properties / data / items / properties / position_name / description
      Removed value: -"That position's name."
    • removedOutput schema / properties / data / items / properties / reviewed_at / description
      Removed value: -"When a recruiter marked the completed request reviewed (ISO 8601)."
    • removedOutput schema / properties / data / items / properties / reviewed_by_name / description
      Removed value: -"Who marked it reviewed."
    • removedOutput schema / properties / data / items / properties / status / description
      Removed value: -"open (waiting for the candidate), completed (every required document uploaded) or cancelled."
    • removedOutput schema / properties / pagination / properties / has_more / description
      Removed value: -"True when more records exist beyond this page (offset + returned < total)."
    • removedOutput schema / properties / pagination / properties / has_more / example
      Removed value: -true
    • removedOutput schema / properties / pagination / properties / limit / description
      Removed value: -"Page size used for this response."
    • removedOutput schema / properties / pagination / properties / limit / example
      Removed value: -50
    • removedOutput schema / properties / pagination / properties / offset / description
      Removed value: -"Offset used for this response."
    • removedOutput schema / properties / pagination / properties / offset / example
      Removed value: -0
    • removedOutput schema / properties / pagination / properties / total / description
      Removed value: -"Total matching records across all pages."
    • removedOutput schema / properties / pagination / properties / total / example
      Removed value: -137
  3. Added

TDQS

A3.5/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true, idempotentHint=true and openWorldHint=true, so the safety and scope profile are covered. The description adds only that queries can be company-wide or per-candidate, which is consistent with openWorld. It says nothing about pagination behavior or return shape, so it is adequate but not rich.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two compact sentences with the resource and scope stated first, then a pointer to more detailed argument docs. Little waste, though the get_tool_reference pointer is a slightly unusual indirection.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With a full input schema, an output schema, and rich annotations, the description covers what an agent needs in order to call it correctly. Only minor gaps (return format, pagination) remain, and those are largely carried by the output schema.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so every parameter is documented in structured form; the baseline of 3 applies. The description adds a little meaning for attention=true and candidate scoping, but then defers full argument detail to get_tool_reference rather than compensating itself.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description opens with a specific tag [Document requests] and a clear statement of the resource: documents asked from candidates, with the scope options (company-wide vs. one candidate). It's distinguishable from write-side siblings like request_candidate_documents or update_document_request, though it doesn't name them explicitly.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It explains the filtering levers (by status, by candidate, attention=true) and clarifies that attention surfaces the ones that need a look (uploaded, overdue). It stops short of saying when to prefer this over update_document_request or request_candidate_documents, and gives no exclusions.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.