内容
<div align="center">
<img src="https://superlore.vercel.app/superlore-mark.svg" width="72" height="72" alt="superlore" />
# superlore
### 您的代理运行的知识库。
您的代理将规格、转录和集思广益转化为丰富、结构化的文档 —
**画布、面板、时间线** — 这些文档汇聚成一个知识库,每个代理都可以阅读 **MCP**。
**_一个语料库。人类和代理。_**
<p>
<a href="https://www.npmjs.com/package/superlore"><img alt="superlore on npm" src="https://img.shields.io/npm/v/superlore?color=6D5CF0&label=superlore" /></a>
<a href="./LICENSE"><img alt="License: Apache 2.0" src="https://img.shields.io/badge/License-Apache_2.0-6D5CF0.svg" /></a>
<a href="./CONTRIBUTING.md"><img alt="PRs welcome" src="https://img.shields.io/badge/PRs-welcome-6D5CF0.svg" /></a>
</p>
<sub>开源 · MCP 原生 · 任意部署</sub>
<b><a href="https://superlore.vercel.app">官网</a></b> · <b><a href="https://superlore.vercel.app/docs">文档</a></b> · <b><a href="https://superlore.vercel.app/viewer">实时演示</a></b> · <b><a href="https://superlore.vercel.app/docs/agents/mcp">MCP</a></b>
</div>
---
## 快速开始
**让您的代理构建它** — 三个快速粘贴到 Claude(分别运行,每个单独运行):
**1 · 添加市场** (一次)
```text
/plugin marketplace add KrishnanSG/superlore
```
**2 · 安装插件**
```text
/plugin install superlore@superlore
```
**3 · 请求您的知识库** — 在新的聊天中
```text
使用 superlore 为我创建一个文档站点
```
就这样。Claude 搭建了项目,初始化了一两个页面,连接了 MCP,设置了编辑器,并进行了预览 — 然后您可以继续与它对话以进行创作。无需学习框架。
更喜欢终端?
```bash
curl -fsSL https://superlore.vercel.app/install.sh | sh
superlore init my-kb && cd my-kb && superlore dev
```
> 将 superlore 添加到现有的 Next.js 应用中?请参阅 [**入门指南**](https://superlore.vercel.app/docs/getting-started)。
---
## 一个区块,两种表现
您的一半文档现在由 **代理** 而不是人类阅读 — 而其他工具只是将 MCP 硬件添加到旧的编写方式中,提供刮擦的、损失的 HTML。superlore 重新思考了文档,以适应 AI 编写、阅读和维护的世界:每个组件都是 **双重表示**。您只需编写一次,同一个区块就会为人类渲染出漂亮的交互式界面 **和** 序列化为干净的、类型化的 MCP 数据 — 可证明是一个来源,没有漂移。
<div align="center">
<img src="apps/docs/public/landing-hero.png" alt="superlore 官网 — 一个作者区块,显示为人类交互式面板,同时也是代理读取的 JSON 数据" width="100%" />
</div>
> 人类看到的面板 **就是** 代理读取的类型化图 — 查询结构,而不是平面图像。
---
## 您获得的功能
- **双重表示组件** — 画布、时间线、面板、实体卡、表格、决策等。每个组件都为人类渲染 **和** 序列化为 MCP 的类型化知识面。
- **画布 — FigJam 代码化。** 声明节点、边和组;superlore 自动设计并布局交互式白板。面板 **就是** 类型化图。
- **MCP 原生。** 每个部署都在 `/api/mcp` 上提供 MCP 服务 — `search`、`get_page`、`list`、`navigate`、`get_component_data`。
- **查看器** — 任意 `.mdx` 文件并实时渲染,带有评论和导出。 [试用 →](https://superlore.vercel.app/viewer)
- **编辑器扩展** — 在 VS Code、Cursor 和 Windsurf 中实时预览每个组件。
- **单配置身份验证** — Auth.js + Google SSO,默认关闭;门控站点或仅 MCP,MCP 继承相同的策略。
- **您可以部署** — 这是您仓库中的 MDX:部署到 Vercel、Cloudflare 或您自己的服务器。或者让 [**superlore 云**](https://superlore.vercel.app/cloud) 为您托管。
[**阅读文档 →**](https://superlore.vercel.app/docs)
---
## 使用 superlore 构建
使用 superlore 构建了知识库?添加徽章:
[](https://superlore.vercel.app)
```md
[](https://superlore.vercel.app)
```
---
## 贡献与许可
superlore 是开源的,旨在发展社区。阅读 [`CONTRIBUTING.md`](./CONTRIBUTING.md) 和 [`CODE_OF_CONDUCT.md`](./CODE_OF_CONDUCT.md);通过 [`SECURITY.md`](./SECURITY.md) 报告漏洞。欢迎 PR。
[Apache-2.0](./LICENSE) © [Krishnan S G](https://github.com/KrishnanSG)
<div align="center">
<br />
<sub><b>superlore</b> — 编写一次。人类和代理读取相同的语料库。</sub>
</div>