box_docgen_template_get_by_name_tool
Retrieve metadata of a specific Box Doc Gen template by its name using the MCP Server Box. Input the template name to access detailed information or error messages for processing documentation templates.
Instructions
Retrieve details of a specific Box Doc Gen template by name.
Args: client (BoxClient): Authenticated Box client. template_name (str): Name of the template.
Returns: dict[str, Any]: Metadata of the template or an error message.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| template_name | Yes |
Implementation Reference
- src/tools/box_tools_docgen.py:76-90 (handler)The main handler function that implements the tool logic. It retrieves the Box client from the MCP context and calls the underlying box_docgen_template_get_by_name function from box_ai_agents_toolkit to fetch the template by name.async def box_docgen_template_get_by_name_tool( ctx: Context, template_name: str ) -> dict[str, Any]: """ Retrieve details of a specific Box Doc Gen template by name. Args: client (BoxClient): Authenticated Box client. template_name (str): Name of the template. Returns: dict[str, Any]: Metadata of the template or an error message. """ box_client = get_box_client(ctx) return box_docgen_template_get_by_name(box_client, template_name)
- src/tool_registry/doc_gen_tools.py:30-30 (registration)The registration of the tool using the FastMCP tool decorator in the doc_gen_tools registry module.mcp.tool()(box_docgen_template_get_by_name_tool)
- src/tool_registry/doc_gen_tools.py:11-11 (registration)The import statement in the registry module that brings in the handler function from src/tools/box_tools_docgen.py.box_docgen_template_get_by_name_tool,