box_docgen_get_job_by_id_tool
Retrieve detailed information about a specific Box Doc Gen job by entering its unique ID, enabling accurate tracking and management of document generation tasks.
Instructions
Retrieve a Box Doc Gen job by its ID.
Args: client (BoxClient): Authenticated Box client. job_id (str): ID of the Doc Gen job.
Returns: dict[str, Any]: Details of the specified Doc Gen job.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| job_id | Yes |
Implementation Reference
- src/tools/box_tools_docgen.py:299-311 (handler)The primary handler function implementing the logic for the 'box_docgen_get_job_by_id_tool'. It fetches the Box client from the context and delegates to the box_docgen_get_job_by_id helper function.async def box_docgen_get_job_by_id_tool(ctx: Context, job_id: str) -> dict[str, Any]: """ Retrieve a Box Doc Gen job by its ID. Args: client (BoxClient): Authenticated Box client. job_id (str): ID of the Doc Gen job. Returns: dict[str, Any]: Details of the specified Doc Gen job. """ box_client = get_box_client(ctx) return box_docgen_get_job_by_id(box_client, job_id)
- src/tool_registry/doc_gen_tools.py:21-21 (registration)The registration of the tool using the MCP FastMCP tool decorator within the register_doc_gen_tools function.mcp.tool()(box_docgen_get_job_by_id_tool)
- src/tool_registry/doc_gen_tools.py:6-6 (registration)Import statement bringing in the tool handler from src/tools/box_tools_docgen.py.box_docgen_get_job_by_id_tool,