get_image
Retrieve metadata and details of a previously generated image by providing its unique ID from RendrKit's AI-powered design API.
Instructions
Get details of a previously generated image
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The image ID |
Implementation Reference
- src/tools/get-image.ts:5-58 (handler)Registers the 'get_image' MCP tool. Takes an image ID, calls client.getImage(), and returns formatted image details (URL, ID, size, style, prompt, brand kit, creation date).
export function registerGetImageTool( server: McpServer, client: RendrKitClient, ): void { server.registerTool( "get_image", { description: "Get details of a previously generated image", inputSchema: { id: z.string().describe("The image ID"), }, }, async ({ id }) => { try { const image = await client.getImage(id); return { content: [ { type: "text" as const, text: [ `Image Details`, ``, `URL: ${image.url}`, `ID: ${image.id}`, `Size: ${image.width}x${image.height}`, `Style: ${image.style}`, `Prompt: ${image.prompt}`, image.brandKitId ? `Brand Kit: ${image.brandKitId}` : null, `Created: ${image.createdAt}`, ] .filter(Boolean) .join("\n"), }, ], }; } catch (error) { const message = error instanceof Error ? error.message : String(error); return { content: [ { type: "text" as const, text: `Failed to get image: ${message}`, }, ], isError: true, }; } }, ); } - src/types.ts:15-24 (schema)ImageDetails type definition - the response schema returned by the get-image tool, containing id, url, width, height, prompt, style, optional brandKitId, and createdAt.
export interface ImageDetails { id: string; url: string; width: number; height: number; prompt: string; style: string; brandKitId?: string; createdAt: string; } - src/api-client.ts:97-99 (helper)API client method that performs the actual HTTP GET request to /api/v1/images/{id} to retrieve image details.
async getImage(id: string): Promise<ImageDetails> { return this.request<ImageDetails>("GET", `/api/v1/images/${id}`); } - src/server.ts:4-28 (registration)Import and registration call for the get_image tool in the main server setup.
import { registerGetImageTool } from "./tools/get-image.js"; import { registerListBrandKitsTool } from "./tools/list-brand-kits.js"; import { registerGetUsageTool } from "./tools/get-usage.js"; import { registerListTemplatesTool } from "./tools/list-templates.js"; import { registerUploadImageTool } from "./tools/upload-image.js"; import { registerBatchRenderTool } from "./tools/batch-render.js"; import { registerCloneTemplateTool } from "./tools/clone-template.js"; export function createServer(client: RendrKitClient): McpServer { const server = new McpServer({ name: "rendrkit", version: "0.3.0", }); registerGenerateImageTool(server, client); registerGetImageTool(server, client); registerListBrandKitsTool(server, client); registerGetUsageTool(server, client); registerListTemplatesTool(server, client); registerUploadImageTool(server, client); registerBatchRenderTool(server, client); registerCloneTemplateTool(server, client); return server; }