get_template_detail
Retrieve detailed template information including input fields, output format, and credit cost to understand requirements before execution.
Instructions
Get full details of a template including its input parameters.
Returns the template's input fields (what you need to provide), output format, description, and credit cost. Use this before executing a template to understand its requirements. No credits charged.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| slug | Yes | Template slug (from list_templates results) |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/yaparai/tools/templates.py:45-64 (handler)Handler function for 'get_template_detail' — takes a slug and returns template details by calling the client.
async def get_template_detail( slug: str, ) -> dict: """ Get full details of a template including its input parameters. Returns the template's input fields (what you need to provide), output format, description, and credit cost. Use this before executing a template to understand its requirements. No credits charged. Args: slug: Template slug (from list_templates results) Returns: Dict with template details: name, description, io_inputs (required fields like prompt, image_url, etc.), credit_cost, and workflow info. """ client = YaparAIClient() return await client.get_template(slug) - src/yaparai/server.py:142-142 (registration)Registration of get_template_detail as an MCP tool in the FastMCP server.
mcp.tool(get_template_detail) - src/yaparai/tools/templates.py:45-64 (schema)Function signature defines the input schema: slug (str) is the only parameter, returns dict.
async def get_template_detail( slug: str, ) -> dict: """ Get full details of a template including its input parameters. Returns the template's input fields (what you need to provide), output format, description, and credit cost. Use this before executing a template to understand its requirements. No credits charged. Args: slug: Template slug (from list_templates results) Returns: Dict with template details: name, description, io_inputs (required fields like prompt, image_url, etc.), credit_cost, and workflow info. """ client = YaparAIClient() return await client.get_template(slug) - src/yaparai/client.py:171-173 (helper)HTTP client method that makes the actual GET request to /v1/comfy-templates/{slug} to retrieve template details.
async def get_template(self, slug: str) -> dict: """Get template detail.""" return await self._request("GET", f"/v1/comfy-templates/{slug}") - src/yaparai/server.py:48-52 (registration)Import of get_template_detail from templates module into the server.
from yaparai.tools.templates import ( list_templates, get_template_detail, execute_template, )