IIIF

Provides IIIF-compliant APIs to search, retrieve metadata, images, annotations, and change information for IIIF resources.

typescript

0

GitHub Stars

typescript

Language

7 months ago

First Indexed

3 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "code4history-iiif_mcp": {
      "command": "node",
      "args": [
        "/path/to/mcp_iiif/dist/index.js"
      ]
    }
  }
}

You learn how to run and use the IIIF MCP Server to access IIIF resources through a unified set of APIs. This server enables you to search IIIF collections, retrieve manifest and canvas data, fetch image data, handle annotations and changes, and manage authentication and media metadata in a coordinated way.

How to use

Configure your MCP client to connect to the IIIF MCP Server by adding the MCP server entry that matches how you plan to deploy the server. You can run the server locally as a lightweight, self-contained process or deploy a prebuilt bundle for easier distribution. Once configured, you can perform common tasks such as searching IIIF resources, retrieving manifests and collections, listing canvases within a manifest, extracting image data, and navigating change streams. Use the client to call the server’s tools and receive either human-readable results or structured JSON data for integration with other systems.

How to install

Prerequisites: ensure you have Node.js and npm installed on your system.

Standard installation steps you can follow to prepare the MCP server for deployment:

npm install
npm run build

Additional sections

Configuration and deployment rely on two runtime options shown for integrating the MCP server with your client or environment.

Standard deployment (distributed as a normal Node.js project): you run the built server from its dist index, and you configure your MCP client to point to that local process.

Single-file bundle deployment (v1.1.0+): you bundle the server into a single file for easy deployment without npm install steps. Use the bundle as the executable entry point for your MCP client configuration.

MCP client configuration snippets shown here illustrate how to connect to the IIIF MCP Server in both standard and bundle deployment modes. Your client will simply invoke the server process with the appropriate command and arguments.

Available tools

iiif-image-fetch

Fetch actual IIIF image data with automatic size constraints and region support, returning a Base64-encoded image or structured data.

iiif-manifest-canvases

List all canvases within a manifest with optional filtering and metadata inclusion.

iiif-canvas-info

Get detailed information about a specific canvas, including dimensions and related annotations.

iiif-search

Search within IIIF resources using the Content Search API, returning hits, labels, and contexts.

iiif-manifest

Retrieve manifest metadata from the IIIF Presentation API with optional property selection and structured output.

iiif-collection

Navigate IIIF collections with hierarchical structures, including sub-collections and manifests.

iiif-image

Build IIIF Image API URLs and optionally fetch image information for a given image.

iiif-annotation

Extract and analyze annotations, including text transcriptions and multilingual content.

iiif-activity

Track changes via the IIIF Change Discovery API and traverse activity streams.

iiif-av

Process audio/video content from IIIF manifests, including duration and dimensions, with optional ranges.

iiif-auth

Handle IIIF authentication flows for protected resources, including info, authenticate, probe, and logout actions.

iiif-range

Navigate structural ranges in IIIF resources (Coming Soon) with range-based endpoints.