@ frontmcp/ sdk (英语)
核心内容 前线MCP,用于构建的 TypeScript 框架 示范背景协议 (MCP)服务器. 您写入工具、 资源和提示为 装饰类; SDK 处理协议、传输、会话、认证、依赖性注入和 请求管道。 同样的服务器运行在你的机器上,在多克,在Vercel或AWS Lambda,在Cloudflare工人上.
用它来构建一个MCP服务器,或者在另一个程序内部运行一个. 这个
frontmcp CLI创建,运行,测试并围绕它构建项目.
安装
与CLI开始一个新项目
npx frontmcp create my-app
或者在您已有的项目中添加 SDK :
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 | 在沙盒中运行动态任务( 标记) |
一个文件中的服务器
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,或
加入克洛德代码:
claude mcp add --transport http demo http://localhost:3000/mcp
工具是类 : @Tool 把它描述给模型, inputSchema 用 佐德语Name
(SDK出口) z),以及 execute 返回结果。 一个 @App 组合工具、资源、提示和提供者
@FrontMcp 是服务器。 这个 快速启动 穿过每一块.
SDK覆盖的内容
| 区域 | 你用的东西 | 文档 |
|---|---|---|
| 服务器和应用程序 | @FrontMcp, (中文(简体) ), @App | 服务器, (中文(简体) ), 应用程序 |
| 什么客户称呼 | @Tool, (中文(简体) ), @Resource, (中文(简体) ), @ResourceTemplate, (中文(简体) ), @Prompt, (中文(简体) ), @Skill | 工具, (中文(简体) ), 资源, (中文(简体) ), 提示, (中文(简体) ), 技能 |
| 需要时间的工作 | @Agent, (中文(简体) ), @Job, (中文(简体) ), @Workflow,背景任务 | 探员, (中文(简体) ), 工作, (中文(简体) ), 工作流量, (中文(简体) ), 任务 |
| 密码 | @Provider (依赖性注射)、钩子、, @Plugin, (中文(简体) ), @Adapter | 供应商, (中文(简体) ), 钩子, (中文(简体) ), 插件 |
| 谁可以打电话 | 授权模式(公共、静态密钥、透明 JWT、本地或远程 OAuth)、会话、权限 | 认证 |
| 议定书 | 每一次MCP修订从 2024-11-05 改为 2026-07-28 每个请求选择一个终点 | 议定书版本 |
| 运行它 | 可流式 HTTP 或 stdio; 与 create();作为OpenAI、克洛德、LangChain和Vercel AI SDK的工具 connect*() | 部署, (中文(简体) ), create(), (中文(简体) ), connect() |
这个 SDK 参考 列出每个装饰器、上下文方法和选项.
与其他框架相比
用于生产的 TypeScript MCP 服务器框架 比较 FrontMCP 和 官方 TypeScript SDK, FastMCP, mcp-framework, mcp-使用,ViteMCP和xmcp,在认证,测试,协议支持和部署上. 要移动服务器,请看 从类型脚本 SDK 移动 财务报告和审定财务报表 从 FastMCP 迁移更长的取向和测量 博客。 。 。 .
相关软件包
frontmcp国家行动倡议:create, (中文(简体) ),dev, (中文(简体) ),build, (中文(简体) ),test@frontmcp/testing——服务器端到端测试@frontmcp/adapters从 OpenAPI 光谱生成工具@frontmcp/auth—— SDK 使用的认证层- 插件 :
@frontmcp/plugin-cache, (中文(简体) ),@frontmcp/plugin-remember, (中文(简体) ),@frontmcp/plugin-approval, (中文(简体) ),@frontmcp/plugin-codecall财务报告和审定财务报表 更多 @frontmcp/ui财务报告和审定财务报表@frontmcp/react—— 工具结果的部件, 和反应钩子 FrontMCP 服务器
保留每个 @frontmcp/* 软件包在同一版本上:在准确版本中它们彼此依赖.
捐款
资料来源: libs/sdk欢迎提出问题和拉动请求;
见 捐款额。 。 。 .
许可证
阿帕奇2.0 (英语). 见 自由主义。 。 。 .