Lucide Icons

A Model Context Protocol (MCP) server exposing Lucide icons as resources and tools for LLMs and agentic applications. Built with Bun and the MCP TypeScript SDK.

typescript

26

GitHub Stars

typescript

Language

6 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": {
    "seeyangzhi-lucide-icons-mcp": {
      "command": "npx",
      "args": [
        "lucide-icons-mcp",
        "--stdio"
      ]
    }
  }
}

You run a Model Context Protocol (MCP) server that exposes Lucide React icons as resources and tools for AI assistants and agentic applications. This server makes it easy to search icons, browse categories, and get React/JSX usage examples, all accessible through MCP-compatible tooling.

How to use

You interact with this MCP server from an MCP client. Start by running it in stdio mode if you plan to integrate with a local toolchain or an editor plugin that expects MCP over a direct pipe. In stdio mode you get a self-contained command you can invoke from your tooling to query icon data, search by name or category, and retrieve usage examples in React/JSX.

How to install

Prerequisites: you need Git and Bun or Node.js installed on your system.

# 1) Clone the project
git clone https://github.com/SeeYangZhi/lucide-icons-mcp.git
cd lucide-icons-mcp

# 2) Install Bun (if you choose Bun). After installation, verify:
bun --version

# 3) Install dependencies
bun install

# 4) Build the project
bun run build

Additional sections

Development and runtime notes help you get up and running quickly with MCP tooling and local testing.

Development scripts provide convenient ways to run, test, lint, and crawl icon data. Use the following commands to start and build your MCP server.

# Start in HTTP mode (development)
bun run dev

# Start in stdio mode (development)
bun run dev:stdio

# Build TypeScript to JavaScript (output in build/)
bun run build

# Lint the codebase
bun run lint

# Auto-fix lint issues when possible
bun run lint:fix

# Crawl Lucide website to update icon data
bun run crawl

# Pre-build workflow: crawl, build metadata, lint
bun run pre-build

Available tools

search_icons

Search Lucide icons by name or category and return matching icons with their categories.

search_categories

Search for icon categories by name with partial matching and return matching categories with counts.

fuzzy_search_icons

Fuzzy search Lucide icons by name to return closely matching icons and their categories.

fuzzy_search_categories

Fuzzy search for icon categories by name and return matching categories with icon counts.

get_icon_usage_examples

Provide React/JSX usage examples for a specific Lucide icon by name.

list_all_icons_by_category

List all icons belonging to a specific Lucide category, with an optional limit.

list_all_categories

List all available icon categories with their icon counts.