OpenAIToolingConfiguration class

OpenAI 工具扩展包的配置。 继承所有工具和运行时设置。

此类存在的原因

尽管此类当前没有添加任何除 ToolingConfiguration 提供的新设置,但存在以下几个重要原因:

  1. 类型安全性:允许 OpenAI 特定的服务声明其依赖项 IConfigurationProvider<OpenAIToolingConfiguration>,使配置协定明确并启用编译时检查。

  2. 扩展点:提供一个明确的位置来添加特定于 OpenAI 的设置(例如,代理 SDK 超时、线程轮询间隔、运行限制),而无需在出现这些需求时中断现有代码。

  3. 一致模式:与其他扩展包(Claude、LangChain)保持对称性,使 SDK 更易于理解和导航。

  4. 依赖关系注入:服务可以设计为接受此特定配置类型,从而启用适当的 IoC 模式和可测试性。

示例

// Service declares explicit dependency on OpenAI configuration
class OpenAIService {
  constructor(private configProvider: IConfigurationProvider<OpenAIToolingConfiguration>) {}
}

// Future: Add OpenAI-specific settings without breaking changes
class OpenAIToolingConfiguration extends ToolingConfiguration {
  get threadPollingInterval(): number { ... }
}
扩展

属性

clusterCategory
isDevelopmentEnvironment

群集是开发环境(本地还是开发环境)。 基于 clusterCategory。

isNodeEnvDevelopment

NODE_ENV是否指示开发模式。 当NODE_ENV“开发”(不区分大小写)时返回 true。 这是指示开发模式的标准 Node.js 方法。

mcpPlatformAuthenticationScope

获取 MCP 平台身份验证范围。 AgenticAuthenticationService 用于令牌交换。 剪裁空格以防止令牌交换失败。

mcpPlatformEndpoint
useToolingManifest

是否使用 ToolingManifest.json 文件而不是网关发现。 如果NODE_ENV设置为“开发”(不区分大小写),或者通过配置显式重写,则返回 true。

继承的方法

getBearerTokenForServer(string)

按名称返回 MCP 服务器的开发模式持有者令牌。 首先检查BEARER_TOKEN_<SERVERNAME_UPPER> ,然后回退到BEARER_TOKEN。 如果未设置变量(不会附加授权标头),则返回未定义。

hasPerServerBearerToken(string)

如果为给定服务器显式设置了每服务器持有者令牌 env var(BEARER_TOKEN_<SERVERNAME_UPPER>),则返回 true;如果仅使用共享BEARER_TOKEN回退,则返回 false。 用于检测在开发模式下以无提示方式回退到错误受众令牌的 V2 服务器。

parseEnvBoolean(undefined | string)

将环境变量分析为布尔值。 将“true”、“1”、“yes”、“on”(不区分大小写)识别为 true;所有其他值都为 false。

parseEnvInt(undefined | string, number)

将环境变量分析为整数,如果设置无效或未设置,则返回回退。

构造函数详细信息

OpenAIToolingConfiguration(ToolingConfigurationOptions)

new OpenAIToolingConfiguration(overrides?: ToolingConfigurationOptions)

参数

属性详细信息

clusterCategory

ClusterCategory clusterCategory

属性值

isDevelopmentEnvironment

群集是开发环境(本地还是开发环境)。 基于 clusterCategory。

boolean isDevelopmentEnvironment

属性值

boolean

isNodeEnvDevelopment

NODE_ENV是否指示开发模式。 当NODE_ENV“开发”(不区分大小写)时返回 true。 这是指示开发模式的标准 Node.js 方法。

boolean isNodeEnvDevelopment

属性值

boolean

mcpPlatformAuthenticationScope

获取 MCP 平台身份验证范围。 AgenticAuthenticationService 用于令牌交换。 剪裁空格以防止令牌交换失败。

string mcpPlatformAuthenticationScope

属性值

string

mcpPlatformEndpoint

string mcpPlatformEndpoint

属性值

string

useToolingManifest

是否使用 ToolingManifest.json 文件而不是网关发现。 如果NODE_ENV设置为“开发”(不区分大小写),或者通过配置显式重写,则返回 true。

boolean useToolingManifest

属性值

boolean

继承的方法详细信息

getBearerTokenForServer(string)

按名称返回 MCP 服务器的开发模式持有者令牌。 首先检查BEARER_TOKEN_<SERVERNAME_UPPER> ,然后回退到BEARER_TOKEN。 如果未设置变量(不会附加授权标头),则返回未定义。

function getBearerTokenForServer(mcpServerName: string): undefined | string

参数

mcpServerName

string

返回

undefined | string

继承自 ToolingConfiguration.getBearerTokenForServer

hasPerServerBearerToken(string)

如果为给定服务器显式设置了每服务器持有者令牌 env var(BEARER_TOKEN_<SERVERNAME_UPPER>),则返回 true;如果仅使用共享BEARER_TOKEN回退,则返回 false。 用于检测在开发模式下以无提示方式回退到错误受众令牌的 V2 服务器。

function hasPerServerBearerToken(mcpServerName: string): boolean

参数

mcpServerName

string

返回

boolean

继承自 ToolingConfiguration.hasPerServerBearerToken

parseEnvBoolean(undefined | string)

将环境变量分析为布尔值。 将“true”、“1”、“yes”、“on”(不区分大小写)识别为 true;所有其他值都为 false。

static function parseEnvBoolean(envValue: undefined | string): boolean

参数

envValue

undefined | string

返回

boolean

继承自 ToolingConfiguration.parseEnvBoolean

parseEnvInt(undefined | string, number)

将环境变量分析为整数,如果设置无效或未设置,则返回回退。

static function parseEnvInt(envValue: undefined | string, fallback: number): number

参数

envValue

undefined | string

fallback

number

返回

number

继承自 ToolingConfiguration.parseEnvInt