# @frontmcp/plugin-dashboard 中文文档

规范地址：https://npmcn.com/package/%40frontmcp/plugin-dashboard/

版本：1\.12\.2
npm 元数据更新时间：2026-11-14T21:09:44.032Z
中文译文更新时间：2026-11-15T15:15:01.806Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40frontmcp/plugin-dashboard
原文对照：https://npmcn.com/package/%40frontmcp/plugin-dashboard/?lang=original
项目主页：https://frontmcp.dev/reference/plugins#the-dashboard
源码仓库：https://github.com/agentfront/frontmcp

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：143 kB，48 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=24\.0\.0
- 运行依赖：1 个
- peer 依赖：@frontmcp/sdk 1\.12\.2，@frontmcp/lazy-zod 1\.12\.2
- 首次发布：2026-01-09T03:03:37.369Z
- 最新版本发布：2026-11-14T21:09:43.682Z
- 近 30 天下载量：7686（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：112（近 12 个月 112 个）

## 中文简介

FrontMCP 的 Dashboard 插件: 显示服务器应用程序、工具、资源和提示的网页和 MCP 端点

## 安装

```sh
npm install @frontmcp/plugin-dashboard
```

也可以使用：`pnpm add @frontmcp/plugin-dashboard`、`yarn add @frontmcp/plugin-dashboard`、`bun add @frontmcp/plugin-dashboard`

## README

# @ frontmcp/plugin-dashboard

一个 FrontMCP 添加,在浏览器中显示服务器的应用程序,工具,资源和提示,作为图表. 用的时候 你建立一个服务器,看看它的作用。 它有两个部分: `DashboardApp`,您将添加到 `apps` 以及哪些 服务于仪表板 `DashboardPlugin`,它规定了选择。 它运行在FrontMCP的节点HTTP服务器上.

[![npm](https://img.shields.io/npm/v/@frontmcp/plugin-dashboard.svg)](https://www.npmjs.com/package/@frontmcp/plugin-dashboard) [![License](https://img.shields.io/npm/l/@frontmcp/plugin-dashboard.svg)](https://github.com/agentfront/frontmcp/blob/main/LICENSE)

## 安装

```bash
npm install @frontmcp/plugin-dashboard @frontmcp/sdk
```

需要节点.js 24或后. 保留 `@frontmcp/sdk` 上.

## 使用量

添加 `DashboardApp` 改为 `apps`注册 `DashboardPlugin.init()` 用于选择:

```ts
import { DashboardApp, DashboardPlugin } from '@frontmcp/plugin-dashboard';
import { App, FrontMcp } from '@frontmcp/sdk';

@App({ id: 'help-desk', name: 'Help Desk' })
class HelpDeskApp {}

@FrontMcp({
  info: { name: 'help-desk', version: '1.0.0' },
  apps: [HelpDeskApp, DashboardApp],
  plugins: [DashboardPlugin.init({ auth: { enabled: true, token: process.env.DASHBOARD_TOKEN } })],
})
export default class Server {}
```

然后打开 `/dashboard` 在服务器端口上( u)`PORT`,其他 3000),以符号为 `Authorization: Bearer <token>` 或者说 `?token=<token>`。然后,页面会设置其请求发送的饼干.

-   **`GET /dashboard`** 用 HTML 页面加载 React, React Flow 和 微调 `esm.sh`浏览器 需要上网.
-   **`/dashboard`** 也是它自己的MCP端点,有三个工具来描述整个服务器: `dashboard:graph`, (中文(简体) ), `dashboard:list-tools` 财务报告和审定财务报表 `dashboard:list-resources`。它们没有在服务器主机上列出 终点 页面从他们读取.
-   **`DashboardPlugin.init()` 单靠自己一文不值.** `DashboardApp` 为仪表板服务,带有默认选项 当没有插件时.
-   **生产中关闭.** 除非你准备好了 `enabled`仪表板何时打开 `NODE_ENV` 没有 `production`,以及 答题 `404` 当是. 用于生产,设定 `enabled: true` 与 `auth`。 。 。 .

## 选项

| 选项 | 默认 | 说明 |
| --- | --- | --- |
| `enabled` | 打开,除非 `NODE_ENV` 实值 `production` | 服务仪表板. |
| `basePath` | `'/dashboard'` | 页面所在. |
| `auth.enabled`, (中文(简体) ), `auth.token` | 关闭 | 需要页面和 MCP 端点的符号,并回答 `401` 没有它. `enabled` 无 `token` 制造 `init()` 掷出. |
| `cdn` | `esm.sh` URL( URL) | 页面从 : `entrypoint`, (中文(简体) ), `react`, (中文(简体) ), `reactDom`, (中文(简体) ), `reactDomClient`, (中文(简体) ), `reactJsxRuntime`, (中文(简体) ), `reactRouter`, (中文(简体) ), `xyflow`, (中文(简体) ), `dagre`, (中文(简体) ), `xyflowCss`。 。 。 . |

仪表板的MCP端点先应用服务器自己的认证,再应用仪表板的 `auth`。在服务器上 使用自己的认证,在 `x-frontmcp-dashboard-token` 头曰.

适用于整个进程的 Dashboard 选项: 秒 `DashboardPlugin.init()` 一个不同的 `auth` 抛出,和 以警告取代每个服务器的第一个.

## 文档

-   [仪表板](https://frontmcp.dev/reference/plugins#the-dashboard): 选项、符号和 MCP 端点
-   [插件和适配器](https://frontmcp.dev/reference/plugins): 每个正式插件, 以及在哪里注册

## 相关软件包

-   [`@frontmcp/sdk`](https://www.npmjs.com/package/@frontmcp/sdk): 此加法扩展的框架
-   [`@frontmcp/plugins`](https://www.npmjs.com/package/@frontmcp/plugins):再出口的元包 `DashboardApp` 财务报告和审定财务报表 `DashboardPlugin` 带有另外三个插件

## 捐款

资料来源: [`plugins/plugin-dashboard`](https://github.com/agentfront/frontmcp/tree/main/plugins/plugin-dashboard)。 。 。 . 欢迎提出问题和拉动请求;见 [捐款额](https://github.com/agentfront/frontmcp/blob/main/CONTRIBUTING.md)。 。 。 .

## 许可证

阿帕奇2.0 (英语). 见 [自由主义](https://github.com/agentfront/frontmcp/blob/main/LICENSE)。 。 。 .

## 常见问题

### @frontmcp/plugin-dashboard 是什么？

FrontMCP 的 Dashboard 插件: 显示服务器应用程序、工具、资源和提示的网页和 MCP 端点

### 如何安装 @frontmcp/plugin-dashboard？

在项目目录运行 npm install @frontmcp/plugin-dashboard，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@frontmcp/sdk（1\.12\.2）、@frontmcp/lazy-zod（1\.12\.2）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @frontmcp/plugin-dashboard 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @frontmcp/plugin-dashboard 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @frontmcp/plugin-dashboard 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=24\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @frontmcp/plugin-dashboard 可以商用吗？

@frontmcp/plugin-dashboard 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @frontmcp/plugin-dashboard 的下载量有多少？

根据 npm 官方下载统计，@frontmcp/plugin-dashboard 在 2026/10/16 – 2026/11/14 这 30 天内被下载 7,686 次，日均约 256 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @frontmcp/plugin-dashboard 还在维护吗？

最新版本 1\.12\.2 发布于 2026/11/15（1 天前）；至今共发布 112 个版本，其中过去 12 个月发布了 112 个；首次发布于 2026/01/09。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。