View Image

Displays images inline in Kitty-compatible terminals by loading, converting, and rendering images via the Kitty graphics protocol.

javascript

0

GitHub Stars

javascript

Language

4 months ago

First Indexed

2 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": {
    "yamalab-view-image-mcp": {
      "command": "node",
      "args": [
        "/path/to/view-image-mcp/index.js"
      ]
    }
  }
}

This MCP server enables you to display images inline in compatible terminals using the Kitty graphics protocol. It reads image files, optionally converts them to PNG, encodes the data, and writes it directly to the terminal for seamless inline viewing.

How to use

To display an image inline, register the MCP server with your Claude Code setup, then invoke the image display tool from Claude Code by specifying the image path. The server handles the image loading, optional conversion, encoding, and writing to the terminal so you can see the image directly in supported terminals.

How to install

Prerequisites you need before installing this MCP server:

macOS as the operating system
Node.js v18 or later

Install steps

git clone <repository-url>
cd view-image-mcp
npm install

Register the MCP server with Claude Code

You register the MCP server so Claude Code can call it to render images in your terminal.

claude mcp add view-image node /path/to/view-image-mcp/index.js

Or you can store the configuration directly in the Claude Code settings file as shown:

## Usage with Claude Code

From Claude Code, request inline image display by providing the path to the image file. The system will call the view-image tool and render the image in your terminal.

## Tool: view\_image

The view\_image tool accepts the following parameter:

- path: The image file path (absolute or relative) to display.

## How it works

The MCP server loads the image file, converts to PNG if needed using sips, Base64-encodes the data, and writes the data to the terminal using the Kitty graphics protocol. The terminal then renders the image inline.

## License

MIT licensed.

## Notes

This server is designed for macOS environments with Ghostty or Kitty terminals that support the Kitty graphics protocol.

## Available tools

### view\_image

Tool to request inline image display by providing the image path.