内容
center" width="100%">
<h2>🎨 nucleo-mcp</h2>
<p>为您的AI助手提供即时访问您已拥有的 <a href="https://leoapp.com">Nucleo</a> 图标。</p>
<a target="_blank" href="https://github.com/AkashRajpurohit/nucleo-mcp/stargazers"><img src="https://img.shields.io/github/stars/AkashRajpurohit/nucleo-mcp" /></a>
<a target="_blank" href="https://github.com/AkashRajpurohit/nucleo-mcp/blob/main/LICENSE"><img src="https://img.shields.io/github/license/AkashRajpurohit/nucleo-mcp" /></a>
<img alt="Node 版本" src="https://img.shields.io/badge/node-%3E%3D22.5-339933?logo=nodedotjs&logoColor=white" />
<img alt="MCP 服务器" src="https://img.shields.io/badge/MCP-server-1f1f1f" />
<img alt="访客" src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fvc.akashrajpurohit.com%2Fc%2Fakash~gh~nucleo-mcp=count&style=flatgithub&label=访客066da5" />
<a target="_blank" href="https://ko-fi.com/akashrajpurohit"><img src="https://img.shields.io/badge/Ko--fi-F16061?style=flat-square&logo=ko-fi&logoColor=white" /></a>
<a target="_blank" href="https://akashrajpurohit.com/sponsors/?ref=nucleo-mcp"><img src="https://img.shields.io/badge/赞助-AkashRajpurohit-F16061?style=flat-square&logoColor=white" /></a>
<a target="_blank" href://twitter.com/akashodes"><img alt="关注 Twitter" src="https://img.shields.io/twitter/follow/akashwhoc?style=social&label=@akashwhocodes">
<br />
<br />
<p align=" <a href="https://github.com/AkashRajpurohit/nucleo-mcp/issues/new?template=bug_report.yml">报告错误</a>
·
<a href="https://github.com/Akpurohit/nucleo-mcp/issues/new?template=.yml">功能请求</a>
·
<a href="https://github.com/AkashRajpurohit?tab=re更多项目</a>
</</div>
Nucleo 拥有数万个图标,通常需要滚动浏览找到合适的图标。该工具将您的Claude Code、Claude Desktop、Cursor 或任何 MCP 客户端)直接连接到您自己的 Nucleo 库,这样您只需询问 — “查找一个轮廓购物购物车”或“将用户配置文件图标保存到此项目中” — 即可在几秒钟内获取 SVG。
它读取 Nucleo 桌面应用程序已经保存在您计算机上的没有任何数据离开您的机器。
## ✨ 功能描述
**它能做到:**
- 按名称或含义搜索所有 Nucleo 图标,优先显示最佳结果。
- 返回您拥有的任何图标的 SVG,支持任何样式(轮廓、字形、双色、彩色)和尺寸。
- 直接将图标保存到您的项目文件夹中。
**它不能做到:**
- **解锁高级图标。** 这不是一种绕过购买 Nucleo 的方法。它只读取您已经购买并获得许可的图标,从您自己机器上的库中。如果您没有获得图标的许可,它将不会出现。
- 将您的库、许可密钥或任何数据发送到任何地方。没有网络调用,也没有账户。
- 更改您的 Nucleo 库。它只从中读取。
## 📦 开始之前
您需要:
- **Nucleo**,已购买并安装。至少打开一次 [桌面应用程序](https://nucleoapp.com/application) 并登录,以便下载您的图标。
- **[Node.js](https://nodejs.org/) 22.5 或更高版本。**
- 一个支持 MCP 的助手(例如 [Claude Code](https://claude.com/claude-code))。
## 🚀 安装
```bash
git clone https://github.com/AkashRajpurohit/nucleo-mcp.git
cd nucleo-mcp
npm install
```
然后在您的助手中使用以下命令注册它。记下 `mcp.mjs` 的完整路径 — 您将在下面需要它:
```bash
echo "$PWD/mcp.mjs"
```
### Claude Code
```bash
claude mcp add nucleo --scope user -- node "$PWD/mcp.mjs"
```
### Claude Desktop
打开 **设置 → 开发者 → 编辑配置** (或直接编辑 `claude_desktop_config.json`)并添加:
```json
{
"mcpServers": {
"nucleo": {
"command": "node",
"args": ["/绝对路径/to/nucleo-mcp/mcp.mjs"]
}
}
}
```
重启 Claude Desktop。
### Cursor
打开 **设置 → MCP → 添加新的全局 MCP 服务器** (或编辑 `~/.cursor/mcp.json`)并添加与上述相同的 `nucleo` 条目:
```json
{
"mcpServers": {
"nucleo": {
"command": "node",
"args": ["/绝对路径/to/nucleo-mcp/mjs"]
}
}
}
```
### Windsurf
编辑 `~/.codeium/windsurf/mcp_config.json` 并在 `mcpServers` 下添加相同的 `nucleo` 条目。
### VS Code (GitHub Copilot)
将其添加到工作区中的 `.vscode/mcp.json` (或从命令面板运行 **MCP: 添加服务器**):
```json
{
"servers": {
"nucleo": {
"command": "node",
"args": ["/绝对路径/to/nucleo-mcp/mcp.mjs"]
}
}
```
### 任何其他 MCP 客户端
注册一个运行 `node /绝对路径/to/nucleo-mcp/mcp.mjs` 的 **stdio** 服务器。服务器只需要这样。
注册后,启动新会话并要求您的助手“检查 Nucleo 状态”。它应该会报告找到的图标和软件包数量。如果它做到了,那么您就准备好了。
## 💬 如何使用
您的助手对话。例如:
- “在 Nucleo 中搜索购物车图标。”
- “显示 24px 的轮廓日历图标。”
- “从 Core 软件包中获取用户图标的轮廓并保存到 `./src/icons`。”
- “我leo 软件包?”
在后台,它提供了五种工具供您的助手自动使用:
| 工具 | 功能 |
|------|--------------|
| `nucleo_status` | 确认库已找到并报告图标和软件包数量。 |
| `nucleo_search` | 按名称和标签查找图标,优先显示最佳结果。 |
| `nucleo_get` | 返回一个图标的 SVG 和详细信息。 |
| `nucleo_list_sets` | 列出您的图标软件包。 |
| `nucleo_save` | 将图标保存到您的项目中。 |
`nucleo_save` 只会在您的助手正在工作的文件夹中写入 — 它不会在您的计算机上写入其他任何地方。
## 🩺 如果它找不到您的图标
自己运行快速检查:
```bash
node cli.mjs status
```
如果它说库未找到:
1. 打开 Nucleo 桌面应用程序并确保您已登录并同步了图标。
2. 如果您的库位于自定义位置,请通过设置 `NUCLEO_DATA_PATH` 指向包含 `data.sqlite3` 和 `sets/` 目录的文件夹来指向它。
默认情况下,它会查找 Nucleo 通常存储其库的位置:
- **macOS** — `~/Library/Application Support/Nucleo/icons`
- **Windows** — `%APPDATA%\Nucleo\icons`
- **Linux** — `~/.config/Nucleo/icons`
## 🧪 在没有助手的情况下试用
您可以从终端运行所有内容以查看其行为:
```bash
node cli.mjs status
node cli.mjs search "shopping cart"
node cli.mjs get cart-shopping
node cli.mjs sets
node cli.mjs save cart-shopping ./icons
```
## ⚖️ 许可和免责声明
**本项目与 Nucleo 或 Nucleo 团队没有任何关联、认可或关联。** 它是一个独立的开源工具,简单地读取您已经拥有的 Nucleo 库。“Nucleo” 是其各自所有者的商标,仅在此用于描述该工具的作用。
图标本身仍受 [Nucleo 许可](https://nucleoapp.com/license) 的约束 — 此工具不会更改您对它们的权限,不会授予您未购买的图标,也不会允许您重新分发它们。像您的 Nucleo 许可一样使用图标。
该工具在 MIT 许可下发布(参见 `LICENSE`)。它按原样提供,不提供任何保证。因为它读取 Nucleo 的本地文件,所以 Nucleo 应用程序的未来更新可能会更改库的存储位置或方式;如果发生这种情况,`nucleo_status` 将告诉您库未找到。