microcms_get_media
Retrieve media files from microCMS with filtering options for images, filenames, and pagination support for managing content assets.
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 |
|---|---|---|---|
| limit | No | Number of media to retrieve (max 100, default 10). Only valid on first request. | |
| imageOnly | No | Set to true to retrieve only image files. Only valid on first request. | |
| fileName | No | Filter media by partial filename match (includes file extension) | |
| token | No | Continuation token for pagination (obtained from previous response, 15-second validity) |
Implementation Reference
- src/tools/get-media.ts:34-57 (handler)The handler function that executes the tool logic: constructs query parameters from input, makes an authenticated GET request to the microCMS Management API /media endpoint, and returns the JSON 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 object including name, description, and detailed inputSchema for validation of parameters (limit, imageOnly, fileName, token).
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/types.ts:87-96 (schema)TypeScript interface defining the MediaToolParameters used by the handler, matching the inputSchema properties.
export interface MediaToolParameters { limit?: number; imageOnly?: boolean; fileName?: string; token?: string; fileData?: string; mimeType?: string; externalUrl?: string; url?: string; } - src/server.ts:124-126 (registration)Switch case in CallToolRequest handler that routes 'microcms_get_media' calls to the handleGetMedia function.
case 'microcms_get_media': result = await handleGetMedia(params as unknown as MediaToolParameters); break; - src/server.ts:20-20 (registration)Import of the tool definition (getMediaTool) and handler (handleGetMedia) from the get-media module.
import { getMediaTool, handleGetMedia } from './tools/get-media.js';