@ frontmcp/plugin-feature-flags (英语)

转换工具、资源、资源模板、提示、技能和代理 前线MCP 服务器 打开和关闭带有特征标记。 给出条目 featureFlag: 'bulk-export'而当那面旗子被关闭 呼叫者, 条目被从每个列表中忽略出来,并在被调用时被拒绝,这样您就可以在之前将一个能力发送给一些用户 每个人。 旗帜来自固定值、 启动暗中、 分拆、 解脱或您的适配器, 并分别被评价 来电 在你的密码里, this.featureFlags 读取一面旗帜.

安装

npm install @frontmcp/plugin-feature-flags

插件运行在 FrontMCP 服务器内, 因此您的应用程序需要 @frontmcp/sdk,与本软件包同版本,以及 节点.js 24或后.

旗下服务的SDK是可选的对等依赖. 为您使用的适配器安装 :

没有它, 服务器无法启动错误, 如 LaunchDarkly SDK not found. Install it: npm install @launchdarkly/node-server-sdk编辑 'static' 财务报告和审定财务报表 'custom' 适配器不需要别的.

使用量

注册插件为 FeatureFlagPlugin.init()门条目 featureFlag数字 :

import { FeatureFlagPlugin } from '@frontmcp/plugin-feature-flags';
import { App, FrontMcp, Tool, ToolContext, z } from '@frontmcp/sdk';

@Tool({
  name: 'bulk_export',
  description: 'Export every ticket as CSV',
  inputSchema: {},
  featureFlag: 'bulk-export',
})
class BulkExportTool extends ToolContext {
  async execute() {
    return { csv: 'id,title\nT-1,Cannot log in' };
  }
}

@Tool({ name: 'search_tickets', description: 'Search support tickets', inputSchema: { query: z.string() } })
class SearchTicketsTool extends ToolContext {
  async execute({ query }: { query: string }) {
    const ranking = (await this.featureFlags.isEnabled('semantic-search', false)) ? 'semantic' : 'keyword';
    return { query, ranking, tickets: ['T-1'] };
  }
}

@App({ id: 'help-desk', name: 'Help Desk', tools: [SearchTicketsTool, BulkExportTool] })
class HelpDeskApp {}

@FrontMcp({
  info: { name: 'help-desk', version: '1.0.0' },
  apps: [HelpDeskApp],
  plugins: [
    FeatureFlagPlugin.init({
      adapter: 'static',
      flags: { 'bulk-export': false, 'semantic-search': true },
    }),
  ],
})
export default class Server {}

给 bulk_export 被删除 tools/list被拒绝 Tool "bulk_export" is disabled by feature flag "bulk-export" 代码 FEATURE_FLAG_DISABLED。 。 。 .

注册于 @FrontMcp,插件打开每个应用程序的条目。 登记在 @App它的大门 应用的条目, 以及任何没有自身特性旗插件的应用程序。 如果一个条目宣布 featureFlag 没有地标 插件到达它,服务器不会启动.

这个 featureFlag 选项

该插件添加 featureFlag 改为 @Tool, (中文(简体) ), @Resource, (中文(简体) ), @ResourceTemplate, (中文(简体) ), @Prompt, (中文(简体) ), @Skill 财务报告和审定财务报表 @Agent数字 :

选项

adapter 选择旗帜来自何处,以及它需要哪些其他选项:

每个适配器还需要:

FeatureFlagPlugin.init() 没有支持 adapter 丢出一个 FeatureFlagConfigurationError。 。 。 .

FeatureFlagPlugin.init({
  adapter: 'launchdarkly',
  config: { sdkKey: process.env.LAUNCHDARKLY_SDK_KEY! },
  attributesResolver: (ctx) => ({ plan: ctx.authInfo?.extra?.['plan'] }),
});

自己的适配器

传递任何执行对象 FeatureFlagAdapter 作为 adapterInstance此处 flagService 代表你的旗帜 服务的客户端 :

import { FeatureFlagPlugin, type FeatureFlagAdapter } from '@frontmcp/plugin-feature-flags';

const flagAdapter: FeatureFlagAdapter = {
  async isEnabled(flagKey, context) {
    return (await flagService.isOn(flagKey, context.userId)) === true;
  },
  async getVariant(flagKey, context) {
    const enabled = (await flagService.isOn(flagKey, context.userId)) === true;
    return { name: enabled ? 'on' : 'off', value: enabled, enabled };
  },
  async evaluateFlags(flagKeys, context) {
    const results = new Map<string, boolean>();
    for (const flagKey of flagKeys) {
      const answer = await flagService.isOn(flagKey, context.userId);
      if (answer !== undefined) results.set(flagKey, answer);
    }
    return results;
  },
};

FeatureFlagPlugin.init({ adapter: 'custom', adapterInstance: flagAdapter });

• evaluateFlags() 名单、大门和 this.featureFlags.isEnabled() 电话 留个钥匙 你什么都不知道 约,所以打电话者 defaultValue 应用; 回答 false 为了一面旗子的关闭.
• getVariant() 服务 this.featureFlags.getVariant()。 。 。 . isEnabled() 需要,尽管插件不叫它.
• 可选 initialize() 服务器启动时运行,以及 destroy() 当被处理.
• 可选 subscribe(listener) 电话 listener 当旗帜可能已经更改并返回停止的函数时 这个 用它,旗子翻转发送连接的客户端 list_changed 上面有你们的旗门 斯普利特.io号, 暗地发射和Unleash适配器执行.

内置适配器也导出: StaticFeatureFlagAdapter, (中文(简体) ), LaunchDarklyFeatureFlagAdapter, (中文(简体) ), SplitioFeatureFlagAdapter 财务报告和审定财务报表 UnleashFeatureFlagAdapter。 。 。 .

旗帜为 enabled

featureFlagSource(adapter, ref) 作为SDK的旗帜 EnabledSource,用于 enabled 工具、资源、模板 或迅速。 给插件一个相同的适配器。 SDK 然后过滤列表, 拒绝该条目 FEATURE_OFF 补救措施 Turn on the feature flag "beta".发送 list_changed 当适配器报告变化时。 这个 一个适配器的源在 SDK 客户端上共享一个收听器 :

import { FeatureFlagPlugin, featureFlagSource, UnleashFeatureFlagAdapter } from '@frontmcp/plugin-feature-flags';

const flags = new UnleashFeatureFlagAdapter({ url: 'https://unleash.example.com/api', appName: 'my-mcp-server' });

@Tool({ name: 'beta_report', inputSchema: {}, enabled: featureFlagSource(flags, 'beta-reports') })
class BetaReportTool extends ToolContext {}

FeatureFlagPlugin.init({ adapter: 'custom', adapterInstance: flags });

this.featureFlags

this.featureFlags 可用工具、资源和提示,并评估当前呼叫者的旗帜:

this.get(FeatureFlagAccessorToken) 返回同一个访问器,并且 this.tryGet(FeatureFlagAccessorToken) 返回它 或者说 undefined 在未安装插件的地方.

当国旗服务失败时

最多 1.11.2 个列表因适配器出错而失败(-32603),并且没有应用默认值.

文档

• 特性旗插件引用:每个选项,每个适配器, 瞄准目标 排除出问题.
• 打开和关闭特性:分步向导.

相关软件包

• @frontmcp/sdk: FrontMCP 框架 此插件运行在其中 .
• @frontmcp/plugin-approval: 拒绝工具直到 批准情况为打电话者记录.

捐款

资料来源: plugins/plugin-feature-flags问题 欢迎抽取请求;见 捐款额。 。 。 .

许可证

阿帕奇2.0 (英语). 见 自由主义。 。 。 .