# @frontmcp/sdk 中文文档

规范地址：https://npmcn.com/package/%40frontmcp/sdk/

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

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

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

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

- 包体积（解压后）：18.7 MB，3062 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=24\.0\.0
- 运行依赖：15 个
- peer 依赖：cors ^2\.8\.5，openai ^4\.0\.0 \|\| ^5\.0\.0 \|\| ^6\.0\.0，express ^4\.18\.0 \|\| ^5\.0\.0，raw-body ^3\.0\.0，content-type ^1\.0\.5，@enclave-vm/core ^2\.16\.0，@anthropic-ai/sdk ^0\.30\.0 \|\| ^0\.78\.0，@opentelemetry/api ^1\.9\.0，@frontmcp/observability 1\.12\.2，@frontmcp/storage-sqlite 1\.12\.2，@opentelemetry/sdk-trace-base ^2\.8\.0
- 首次发布：2025-11-05T01:55:12.121Z
- 最新版本发布：2026-11-14T21:14:40.008Z
- 近 30 天下载量：44309（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：129（近 12 个月 119 个）

## 中文简介

用于构建 MCP 服务器的TypeScript 框架:作为装饰类的工具、资源和提示,包括运输、会话、认证和依赖性注入

## 安装

```sh
npm install @frontmcp/sdk
```

也可以使用：`pnpm add @frontmcp/sdk`、`yarn add @frontmcp/sdk`、`bun add @frontmcp/sdk`

## README

[![FrontMCP - The TypeScript way to build MCP servers](https://raw.githubusercontent.com/agentfront/frontmcp/v1.9.6/.github/assets/readme/hero.light.svg)](https://frontmcp.dev/)

# @ frontmcp/ sdk (英语)

核心内容 [前线MCP](https://frontmcp.dev/),用于构建的 TypeScript 框架 [示范背景协议](https://modelcontextprotocol.io/) (MCP)服务器. 您写入工具、 资源和提示为 装饰类; SDK 处理协议、传输、会话、认证、依赖性注入和 请求管道。 同样的服务器运行在你的机器上,在多克,在Vercel或AWS Lambda,在Cloudflare工人上.

用它来构建一个MCP服务器,或者在另一个程序内部运行一个. 这个 [`frontmcp`](https://www.npmjs.com/package/frontmcp) CLI创建,运行,测试并围绕它构建项目.

[![npm](https://img.shields.io/npm/v/@frontmcp/sdk.svg)](https://www.npmjs.com/package/@frontmcp/sdk) [![Node](https://img.shields.io/node/v/@frontmcp/sdk.svg)](https://nodejs.org/) [![License](https://img.shields.io/npm/l/@frontmcp/sdk.svg)](https://github.com/agentfront/frontmcp/blob/main/LICENSE)

## 安装

与CLI开始一个新项目

```bash
npx frontmcp create my-app
```

或者在您已有的项目中添加 SDK :

```bash
npm install @frontmcp/sdk reflect-metadata
npm install -D frontmcp typescript @types/node@^24
npx frontmcp init
```

FrontMCP需要节点.js 24或后. `frontmcp init` 打开 `experimentalDecorators` 财务报告和审定财务报表 `emitDecoratorMetadata` 内 `tsconfig.json`导入 `reflect-metadata` 一次,在您的条目文件的顶端, 在FrontMCP的任何东西之前.

npm和 pnpm 安装 SDK 所需的对等依赖性(`express`, (中文(简体) ), `cors`, (中文(简体) ), `content-type` 财务报告和审定财务报表 `raw-body`为你; 和雅恩,加入他们自己。 有可选的功能:

| 安装 | 改为: |
| --- | --- |
| `@frontmcp/storage-sqlite` | 在 SQLite 中保留会话、任务和活动 |
| `@frontmcp/observability`, (中文(简体) ), `@opentelemetry/api`, (中文(简体) ), `@opentelemetry/sdk-trace-base` | 使用 OpenTeleometry 追踪和日志请求 |
| `openai` 或者说 `@anthropic-ai/sdk` | 运行一个 `@Agent` 在 OpenAI 或 Athropic 模型上 |
| `@enclave-vm/core` | 在沙盒中运行动态任务( 标记) |

## 一个文件中的服务器

```ts
import 'reflect-metadata';

import { App, FrontMcp, Tool, ToolContext, z } from '@frontmcp/sdk';

@Tool({
  name: 'add',
  description: 'Add two numbers',
  inputSchema: { a: z.number(), b: z.number() },
})
class AddTool extends ToolContext {
  async execute(input: { a: number; b: number }) {
    return input.a + input.b;
  }
}

@App({ id: 'calc', name: 'Calculator', tools: [AddTool] })
class CalcApp {}

@FrontMcp({
  info: { name: 'Demo', version: '0.1.0' },
  apps: [CalcApp],
  http: { port: 3000, entryPath: '/mcp' },
})
export default class Server {}
```

保存为 `src/main.ts` 运行 `npx frontmcp dev`。当您编辑它时,服务器会重新加载,并回复 MCP 请求 `http://localhost:3000/mcp` (单位:千美元) `/` 无 `entryPath`) (中文(简体) ). 试试看MCP督察, `npx frontmcp inspector`,或 加入克洛德代码:

```bash
claude mcp add --transport http demo http://localhost:3000/mcp
```

工具是类 : `@Tool` 把它描述给模型, `inputSchema` 用 [佐德语Name](https://zod.dev/) (SDK出口) `z`),以及 `execute` 返回结果。 一个 `@App` 组合工具、资源、提示和提供者 `@FrontMcp` 是服务器。 这个 [快速启动](https://frontmcp.dev/learn) 穿过每一块.

## SDK覆盖的内容

| 区域 | 你用的东西 | 文档 |
| --- | --- | --- |
| 服务器和应用程序 | `@FrontMcp`, (中文(简体) ), `@App` | [服务器](https://frontmcp.dev/reference/sdk/frontmcp), (中文(简体) ), [应用程序](https://frontmcp.dev/reference/sdk/app) |
| 什么客户称呼 | `@Tool`, (中文(简体) ), `@Resource`, (中文(简体) ), `@ResourceTemplate`, (中文(简体) ), `@Prompt`, (中文(简体) ), `@Skill` | [工具](https://frontmcp.dev/reference/sdk/tool), (中文(简体) ), [资源](https://frontmcp.dev/reference/sdk/resource), (中文(简体) ), [提示](https://frontmcp.dev/reference/sdk/prompt), (中文(简体) ), [技能](https://frontmcp.dev/reference/sdk/skill) |
| 需要时间的工作 | `@Agent`, (中文(简体) ), `@Job`, (中文(简体) ), `@Workflow`,背景任务 | [探员](https://frontmcp.dev/reference/sdk/agent), (中文(简体) ), [工作](https://frontmcp.dev/reference/sdk/job), (中文(简体) ), [工作流量](https://frontmcp.dev/reference/sdk/workflow), (中文(简体) ), [任务](https://frontmcp.dev/reference/server/tasks) |
| 密码 | `@Provider` (依赖性注射)、钩子、, `@Plugin`, (中文(简体) ), `@Adapter` | [供应商](https://frontmcp.dev/reference/sdk/provider), (中文(简体) ), [钩子](https://frontmcp.dev/reference/sdk/hooks), (中文(简体) ), [插件](https://frontmcp.dev/reference/plugins) |
| 谁可以打电话 | 授权模式(公共、静态密钥、透明 JWT、本地或远程 OAuth)、会话、权限 | [认证](https://frontmcp.dev/reference/auth) |
| 议定书 | 每一次MCP修订从 `2024-11-05` 改为 `2026-07-28` 每个请求选择一个终点 | [议定书版本](https://frontmcp.dev/reference/server/protocol-versions) |
| 运行它 | 可流式 HTTP 或 stdio; 与 `create()`;作为OpenAI、克洛德、LangChain和Vercel AI SDK的工具 `connect*()` | [部署](https://frontmcp.dev/reference/deployment), (中文(简体) ), [`create()`](https://frontmcp.dev/reference/sdk/create), (中文(简体) ), [`connect()`](https://frontmcp.dev/reference/sdk/connect) |

这个 [SDK 参考](https://frontmcp.dev/reference/sdk) 列出每个装饰器、上下文方法和选项.

## 与其他框架相比

[用于生产的 TypeScript MCP 服务器框架](https://frontmcp.dev/compare) 比较 FrontMCP 和 官方 TypeScript SDK, FastMCP, mcp-framework, mcp-使用,ViteMCP和xmcp,在认证,测试,协议支持和部署上. 要移动服务器,请看 [从类型脚本 SDK 移动](https://frontmcp.dev/learn/migrating-from-the-typescript-sdk) 财务报告和审定财务报表 [从 FastMCP 迁移](https://frontmcp.dev/learn/migrating-from-fastmcp)更长的取向和测量 [博客](https://frontmcp.dev/blog)。 。 。 .

## 相关软件包

-   [`frontmcp`](https://www.npmjs.com/package/frontmcp) 国家行动倡议: `create`, (中文(简体) ), `dev`, (中文(简体) ), `build`, (中文(简体) ), `test`
-   [`@frontmcp/testing`](https://www.npmjs.com/package/@frontmcp/testing) ——服务器端到端测试
-   [`@frontmcp/adapters`](https://www.npmjs.com/package/@frontmcp/adapters) 从 OpenAPI 光谱生成工具
-   [`@frontmcp/auth`](https://www.npmjs.com/package/@frontmcp/auth) —— SDK 使用的认证层
-   插件 : [`@frontmcp/plugin-cache`](https://www.npmjs.com/package/@frontmcp/plugin-cache), (中文(简体) ), [`@frontmcp/plugin-remember`](https://www.npmjs.com/package/@frontmcp/plugin-remember), (中文(简体) ), [`@frontmcp/plugin-approval`](https://www.npmjs.com/package/@frontmcp/plugin-approval), (中文(简体) ), [`@frontmcp/plugin-codecall`](https://www.npmjs.com/package/@frontmcp/plugin-codecall) 财务报告和审定财务报表 [更多](https://frontmcp.dev/reference/plugins)
-   [`@frontmcp/ui`](https://www.npmjs.com/package/@frontmcp/ui) 财务报告和审定财务报表 [`@frontmcp/react`](https://www.npmjs.com/package/@frontmcp/react) —— 工具结果的部件, 和反应钩子 FrontMCP 服务器

保留每个 `@frontmcp/*` 软件包在同一版本上:在准确版本中它们彼此依赖.

## 捐款

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

## 许可证

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

## 常见问题

### @frontmcp/sdk 是什么？

用于构建 MCP 服务器的TypeScript 框架:作为装饰类的工具、资源和提示,包括运输、会话、认证和依赖性注入

### 如何安装 @frontmcp/sdk？

在项目目录运行 npm install @frontmcp/sdk，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：cors（^2\.8\.5）、express（^4\.18\.0 \|\| ^5\.0\.0）、raw-body（^3\.0\.0）、content-type（^1\.0\.5）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @frontmcp/sdk 支持 TypeScript 吗？

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

### @frontmcp/sdk 支持 ESM 还是 CommonJS？

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

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

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

### @frontmcp/sdk 可以商用吗？

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

### @frontmcp/sdk 的下载量有多少？

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

### @frontmcp/sdk 还在维护吗？

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