box_docgen_list_jobs_by_batch_tool
Enables users to list document generation jobs within a specific batch on the MCP Server Box. Specify the batch ID, pagination marker, and limit to retrieve job details efficiently.
Instructions
List Doc Gen jobs in a specific batch.
Args: client (BoxClient): Authenticated Box client. batch_id (str): ID of the Doc Gen batch. marker (str, optional): Pagination marker. limit (int, optional): Maximum number of items to return.
Returns: list[dict[str, Any]]: A list of Doc Gen jobs in the batch.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| batch_id | Yes | ||
| limit | No | ||
| marker | No |
Implementation Reference
- src/tools/box_tools_docgen.py:275-297 (handler)The main handler function for the 'box_docgen_list_jobs_by_batch_tool' tool. It retrieves the Box client from the context and delegates to the 'box_docgen_list_jobs_by_batch' helper function.async def box_docgen_list_jobs_by_batch_tool( ctx: Context, batch_id: str, marker: Optional[str] = None, limit: Optional[int] = None, ) -> list[dict[str, Any]]: """ List Doc Gen jobs in a specific batch. Args: client (BoxClient): Authenticated Box client. batch_id (str): ID of the Doc Gen batch. marker (str, optional): Pagination marker. limit (int, optional): Maximum number of items to return. Returns: list[dict[str, Any]]: A list of Doc Gen jobs in the batch. """ box_client = get_box_client(ctx) return box_docgen_list_jobs_by_batch( box_client, batch_id=batch_id, marker=marker, limit=limit )
- src/tool_registry/doc_gen_tools.py:23-23 (registration)The registration of the tool using the FastMCP tool decorator.mcp.tool()(box_docgen_list_jobs_by_batch_tool)
- src/tool_registry/doc_gen_tools.py:7-7 (registration)The import statement that brings the tool handler into the registry module.box_docgen_list_jobs_by_batch_tool,