这是一个使用MCP(模型上下文协议)的服务器,它公开了Lucide React图标作为资源和工具,供LLM和代理应用程序使用。该服务器使用Bun和MCP TypeScript SDK构建。
Lucide是一个由社区创建的美观且一致的图标工具包。它是一个开源图标库,提供了超过1,500个精心设计的图标,并采用单一、一致的风格。Lucide最初是从Feather Icons分叉出来的,现在已经成长为现代Web开发中最受欢迎的图标库之一。
MCP(模型上下文协议)是一种标准,允许AI工具从其主要训练数据之外的来源请求特定的上下文信息。
这个MCP服务器允许AI编码助手和其他代理应用程序访问关于Lucide React图标的详细信息,从而更好地帮助进行图标搜索、发现和实现。
git clone https://github.com/SeeYangZhi/lucide-icons-mcp.git
cd lucide-icons-mcp
参考官方Bun安装指南。
安装后,请重启终端并检查:
bun --version
bun install
这会将TypeScript源代码编译到build目录中的JavaScript文件中。
bun run build
你可以使用npx运行HTTP服务器:
npx lucide-icons-mcp
这将启动HTTP服务器(默认端口为3000)。
或者全局安装:
npm install -g lucide-icons-mcp
然后运行:
lucide-icons-mcp
npx lucide-icons-mcp --stdio
# 或者如果已全局安装
lucide-icons-mcp --stdio
有两种主要方式来运行MCP服务器:
适合支持HTTP通信的客户端。
对于开发(使用Bun):
bun run start
# 或者直接
bun run src/entry.ts
通常用于与Claude Desktop或MCP Inspector等工具的直接集成。
对于开发(使用Bun):
bun run src/entry.ts --stdio
要在Claude Desktop中使用此MCP服务器:
code ~/Library/Application\ Support/Claude/claude_desktop_config.json
mcpServers部分:选项A:通过npx(推荐):
{
"mcpServers": {
"lucide-icons": {
"command": "npx",
"args": ["lucide-icons-mcp", "--stdio"]
}
}
}
选项B:直接指向构建输出:
{
"mcpServers": {
"lucide-icons": {
"command": "node",
"args": ["/ABSOLUTE/PATH/TO/lucide-icons-mcp/build/entry.js", "--stdio"]
}
}
}
此MCP服务器向AI编码助手公开以下工具。每个图标可以属于多个类别,提供灵活的搜索和发现能力。
query(字符串):图标名称或类别的搜索词category(可选字符串):按特定类别筛选limit(可选数字):要返回的最大结果数name和categories(字符串数组)的图标数组query(字符串):类别名称的搜索词limit(可选数字):要返回的最大结果数name和iconCount的类别数组query(字符串):图标的搜索词limit(可选数字):要返回的最大结果数name和categories(字符串数组)的图标数组query(字符串):类别名称的搜索词limit(可选数字):要返回的最大结果数name和iconCount(字符串数组)的类别数组name(字符串):图标的搜索词category(字符串):要列出图标的类别名称limit(可选数字):要返回的最大结果数这里是如何一个AI工具可能使用此MCP服务器:
用户:"给我找一些与ArrowRight相关的图标"
AI工具调用search_icons:
{
"query": "ArrowRight",
"limit": 5
}
响应:列出如ArrowRight的图标
用户:"展示如何使用ArrowRight图标"
AI工具调用get_icon_usage_examples:
{
"name": "ArrowRight"
}
响应:
import { ArrowRight } from "lucide-react";
function Example() {
return (
<div>
<ArrowRight />
</div>
);
}
用户:"有哪些与设计相关的图标?"
AI工具调用search_categories:
{
"query": "design"
}
然后调用list_icons_by_category:
{
"category": "Design",
"limit": 10
}
Lucide图标被组织成如下类别:
你可以使用MCP Inspector来本地测试MCP服务器。
首先确保项目已经构建:
bun run build
然后启动Inspector:
npx @modelcontextprotocol/inspector node ./build/entry.js --stdio
这将打开Inspector界面,以交互方式测试你的MCP服务器。
bun run dev:以HTTP模式启动服务器进行开发bun run dev:stdio:以stdio模式启动MCP服务器进行开发bun run build:将TypeScript编译为JavaScript(输出在build/中)bun run lint:使用ESLint对代码库进行检查bun run lint:fix:自动修复检查问题bun run crawl:爬取Lucide网站以更新图标数据bun run pre-build:爬取数据,构建图标元数据并修复检查该项目包括一个网络爬虫,自动从Lucide网站提取图标信息,确保图标数据和类别是最新的。
本项目根据MIT许可证发布。详情见LICENSE。
本项目引用了来自Lucide (https://lucide.dev/)的图标,这些图标 根据其ISC许可证授权:
ISC许可证
版权(c)Lucide的部分内容由Cole Bemis于2013-2022年持有,作为Feather的一部分(MIT)。Lucide的所有其他版权(c)由Lucide贡献者于2022年持有。
在此授予任何人出于任何目的使用、复制、修改和/或分发此软件的权利,无论是否付费,前提是上述版权声明和本许可声明出现在所有副本中。
软件按“原样”提供,作者不对此软件做出任何明示或暗示的保证,包括但不限于适销性和适用性的默示保证。在任何情况下,作者都不应对因使用或执行此软件而引起的任何特殊、直接、间接或附带损害或任何形式的损害负责,无论是合同行为、疏忽或其他侵权行为。