Skip to main content
Glama
lzlrd
by lzlrd
README.md
# realfavicon-mcp

MCP server for RealFaviconGenerator: generate, check, and change-log favicons.

## Requirements

Bun >= 1.3.

## Install

```sh
bun install
```

## Run

```sh
bun run start
```

Speaks MCP over stdio. Wire into an MCP client (e.g. Claude Desktop, any MCP-compatible host).

## Install as a Claude Code Plugin

No build step — Claude Code runs the server straight from source with [Bun](https://bun.sh) (required on your `PATH`); Bun fetches dependencies on first launch.

```
/plugin marketplace add lzlrd/realfavicon-mcp
/plugin install realfavicon-mcp@realfavicon-mcp
```

This repo is itself the plugin (`.claude-plugin/`), bundling the MCP server — its tools then appear over MCP.

## Tools

| Tool | Purpose | Inputs |
|------|---------|--------|
| `realfavicon_generate` | Generate a full favicon set (PNG, ICO, SVG, webmanifest) plus HTML markup from a master image. | `source` (path or URL), `output_dir`, optional: `path`, `app_name`, `short_name`, `theme_color`, `background_color`, `app_title`, `version`, `dark_icon_source` |
| `realfavicon_check` | Audit a live page's `<head>` for favicon correctness; returns per-platform messages and icon metadata. | `url` (page URL), optional: `include_icon_data` (default `false`) |
| `realfavicon_changelog` | Fetch the RealFaviconGenerator change-log; optionally filter to changes after a given version. | optional: `since` (version string), `format` (`markdown` or `html`, default `markdown`) |

## Develop

```sh
bun run dev   # watch mode
bun test      # run the test suite
```

## Licence

Licensed under the PolyForm Noncommercial Licence 1.0.0. © 2026 Diab Neiroukh — see `LICENSE`.