microcms_get_media
Retrieve media files from microCMS, including URLs and image dimensions. Supports filtering by filename, image type, and pagination with a 15-second token. Requires media retrieval permissions.
Instructions
Get media files from microCMS (Management API). Returns media information including URLs, dimensions for images. Supports pagination via token (15-second validity). Requires media retrieval permissions.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fileName | No | Filter media by partial filename match (includes file extension) | |
| imageOnly | No | Set to true to retrieve only image files. Only valid on first request. | |
| limit | No | Number of media to retrieve (max 100, default 10). Only valid on first request. | |
| token | No | Continuation token for pagination (obtained from previous response, 15-second validity) |
Implementation Reference
- src/tools/get-media.ts:34-57 (handler)Core handler function that constructs the API request to retrieve media files from microCMS Management API based on input parameters (limit, imageOnly, fileName, token), authenticates with API key, and returns the paginated response.export async function handleGetMedia(params: MediaToolParameters) { const queryParams = new URLSearchParams(); if (params.limit) queryParams.append('limit', params.limit.toString()); if (params.imageOnly) queryParams.append('imageOnly', 'true'); if (params.fileName) queryParams.append('fileName', params.fileName); if (params.token) queryParams.append('token', params.token); const response = await fetch( `https://${microCMSConfig.serviceDomain}.microcms-management.io/api/v2/media?${queryParams}`, { method: 'GET', headers: { 'X-MICROCMS-API-KEY': microCMSConfig.apiKey, }, } ); if (!response.ok) { throw new Error(`Media retrieval failed: ${response.status} ${response.statusText}`); } return await response.json(); }
- src/tools/get-media.ts:5-32 (schema)Tool definition including name, description, and JSON input schema for validating parameters used in media retrieval.export const getMediaTool: Tool = { name: 'microcms_get_media', description: 'Get media files from microCMS (Management API). Returns media information including URLs, dimensions for images. Supports pagination via token (15-second validity). Requires media retrieval permissions.', inputSchema: { type: 'object', properties: { limit: { type: 'number', description: 'Number of media to retrieve (max 100, default 10). Only valid on first request.', minimum: 1, maximum: 100, }, imageOnly: { type: 'boolean', description: 'Set to true to retrieve only image files. Only valid on first request.', }, fileName: { type: 'string', description: 'Filter media by partial filename match (includes file extension)', }, token: { type: 'string', description: 'Continuation token for pagination (obtained from previous response, 15-second validity)', }, }, required: [], }, };
- src/server.ts:20-20 (registration)Imports the tool definition (getMediaTool) and handler function (handleGetMedia) necessary for registration and dispatch.import { getMediaTool, handleGetMedia } from './tools/get-media.js';
- src/server.ts:110-112 (registration)Switch case in tool call handler that routes 'microcms_get_media' requests to the specific handleGetMedia function.case 'microcms_get_media': result = await handleGetMedia(params as unknown as MediaToolParameters); break;
- src/types.ts:87-96 (schema)TypeScript interface defining the parameters for media-related tools, used for type safety in the handler.export interface MediaToolParameters { limit?: number; imageOnly?: boolean; fileName?: string; token?: string; fileData?: string; mimeType?: string; externalUrl?: string; url?: string; }