@xbbg/langgraph 1.4.2 → 1.4.4

package/README.md

@@ -4,10 +4,16 @@ LangChain/LangGraph-compatible Bloomberg tools backed by [`@xbbg/core`](../js-xb
 
 This package is a reusable tool adapter. It is not a chat app, HTTP server, MCP server, browser package, or agent framework.
 
+## Status
+
+Supported server-side LangChain/LangGraph adapter for Bloomberg-connected Node.js 24+ environments. `@xbbg/langgraph` is published alongside `@xbbg/core`, uses the same semver release cadence, and keeps Bloomberg connectivity in the core Node binding while exposing bounded tools, structured artifacts, and model-facing guidance for agent runtimes.
+
 ## Prerequisites
 
 Bloomberg connectivity is still provided by `@xbbg/core`: an installed Bloomberg Terminal/Desktop API, B-PIPE, SAPI, or ZFP setup plus Bloomberg SDK runtime libraries must be available on the server running the tools.
 
+The package targets Node.js 24+ and runs on the server side. It is not a browser package; frontends should call an application backend that owns Bloomberg connectivity.
+
 ## Install
 
 Tool package only:
@@ -124,6 +130,7 @@ Core Bloomberg request tools:
 - `xbbg_bds` - one Bloomberg bulk/table field.
 - `xbbg_bdib` - intraday bars; requires explicit `start`, `end`, and `interval`.
 - `xbbg_bdtick` - intraday ticks; requires explicit `start`, `end`, and event types when the default stream is not intended.
+- `xbbg_check_entitlements` - checks a nonempty EID list against `//blp/refdata` or an explicitly supplied Bloomberg service.
 - `xbbg_bql` - BQL expressions only.
 - `xbbg_bsrch` - Bloomberg search/grid requests, not normal security lookup.
 - `xbbg_bqr` - Bloomberg Quote Request / fixed-income dealer quotes; prefer identifiers such as `/isin/<ISIN>@<QUOTE_SOURCE> <MARKET_SECTOR>`.
@@ -140,6 +147,30 @@ Core Bloomberg request tools:
 - `xbbg_mktbar_snapshot` - bounded `//blp/mktbar` live bar observation for one ticker.
 - `xbbg_depth_snapshot` - bounded `//blp/mktdepthdata` market-depth observation for one ticker.
 
+### Entitlement IDs
+
+The `xbbg_bdp`, `xbbg_bds`, `xbbg_bdh`, `xbbg_bdib`, and `xbbg_bdtick` inputs accept `returnEids: true`. These map only to Bloomberg's EID-capable `ReferenceDataRequest` (including BDS), `HistoricalDataRequest`, `IntradayBarRequest`, and `IntradayTickRequest` operations.
+
+When EIDs are requested, bounded tool artifacts retain result metadata alongside the bounded rows:
+
+```json
+{
+  "data": {
+    "rows": [],
+    "eidData": { "<TICKER> <MARKET_SECTOR>": [101, 202] },
+    "metadata": { "xbbg.eid_data": "{\"<TICKER> <MARKET_SECTOR>\":[101,202]}" }
+  },
+  "rowCount": 0,
+  "truncated": false
+}
+```
+
+Row bounding does not discard `eidData`, `metadata`, `securityErrors`, or `fieldExceptions`. Pass the collected IDs to `xbbg_check_entitlements`:
+
+```json
+{ "eids": [101, 202], "service": "//blp/refdata" }
+```
+
 Securities are passed through in the form the user supplied them: Bloomberg tickers as `<TICKER> <MARKET_SECTOR>` (for example `<TICKER> <EXCHANGE> Equity`, `<INDEX_TICKER> Index`, `<CCY_PAIR> Curncy`), raw ISINs as `/isin/<ISIN>`, raw CUSIPs as `/cusip/<CUSIP>`. The market sector ending is Bloomberg's yellow key — `Equity`, `Index`, `Curncy`, `Comdty`, `Corp`, `Govt`, `Muni`, `Mtge`, `M-Mkt`, or `Pfd` (preferred securities) — and request tools pass it through to Bloomberg unvalidated. The agent guidance and every securities/ticker field description instruct the model that the ticker format is a template, not authorization to construct one — identifiers are never converted into guessed tickers; `xbbg_resolve_isins` exists for explicit resolution. Note `xbbg_ext_ticker`'s `parse_ticker` is narrower than the request tools: it parses generic futures-style tickers only (`Index`/`Curncy`/`Comdty`/`Corp`, or `<ROOT><N> <EXCHANGE> Equity`) and rejects other sectors.
 BQL is passed as one complete expression string. Use placeholder shapes such as `get(<FIELD>) for('<TICKER> <MARKET_SECTOR>')`, `get(<FIELD_1>, <FIELD_2>) for(['<TICKER_1> <MARKET_SECTOR>', '<TICKER_2> <MARKET_SECTOR>'])`, `get(<FIELD>, <WEIGHT_FIELD>) for(holdings('<ETF_TICKER> <MARKET_SECTOR>'))`, or `get(<FIELD>) for(members('<INDEX_TICKER> <MARKET_SECTOR>')) with(...)`. Prefer `xbbg_bdp`/`xbbg_bdh` for simple reference or historical requests.
 

package/dist/index.d.ts

@@ -2,10 +2,28 @@ import * as xbbg from '@xbbg/core';
 import { StructuredToolInterface } from '@langchain/core/tools';
 
 type XbbgCoreModule = typeof xbbg;
-type XbbgEngineLike = Pick<Awaited<ReturnType<XbbgCoreModule["connect"]>>, "bdp" | "bdh" | "bds" | "bdib" | "bdtick" | "bql" | "bsrch" | "bqr" | "bflds" | "beqs" | "yas" | "preferreds" | "corporateBonds" | "indexMembers" | "resolveIsins" | "issuerIsins" | "etfHoldings" | "stream" | "mktbar" | "depth">;
-type XbbgCoreLike = Pick<XbbgCoreModule, "connect" | "ext">;
+interface EntitlementReport {
+    readonly entitled: boolean;
+    readonly failedEids: readonly number[];
+}
+type CoreEngineMethods = Pick<Awaited<ReturnType<XbbgCoreModule["connect"]>>, "bdp" | "bdh" | "bds" | "bql" | "bsrch" | "bqr" | "bflds" | "beqs" | "yas" | "preferreds" | "corporateBonds" | "indexMembers" | "resolveIsins" | "issuerIsins" | "etfHoldings" | "stream" | "mktbar" | "depth">;
+type XbbgEngineLike = {
+    readonly [Method in keyof CoreEngineMethods]: OmitThisParameter<CoreEngineMethods[Method]>;
+} & {
+    readonly bdib: (ticker: string, options: xbbg.BdibOptions & {
+        readonly returnEids?: boolean;
+    }) => Promise<unknown>;
+    readonly bdtick: (ticker: string, options: xbbg.BdtickOptions & {
+        readonly returnEids?: boolean;
+    }) => Promise<unknown>;
+    readonly checkEntitlements: (service: string, eids: readonly number[]) => Promise<EntitlementReport>;
+};
+interface XbbgCoreLike {
+    readonly ext: XbbgCoreModule["ext"];
+    readonly connect: (config?: xbbg.EngineConfig) => Promise<XbbgEngineLike>;
+}
 
-declare const BLOOMBERG_TOOL_NAMES: readonly ["xbbg_bdp", "xbbg_bdh", "xbbg_bds", "xbbg_bdib", "xbbg_bdtick", "xbbg_bql", "xbbg_bsrch", "xbbg_bqr", "xbbg_bflds", "xbbg_beqs", "xbbg_yas", "xbbg_preferreds", "xbbg_corporate_bonds", "xbbg_index_members", "xbbg_resolve_isins", "xbbg_issuer_isins", "xbbg_etf_holdings", "xbbg_stream_snapshot", "xbbg_mktbar_snapshot", "xbbg_depth_snapshot", "xbbg_ext_ticker", "xbbg_ext_futures", "xbbg_ext_cdx", "xbbg_ext_currency", "xbbg_ext_bql_builder", "xbbg_ext_chart_spec", "xbbg_ext_market_session", "xbbg_ext_yas_overrides", "xbbg_ext_constants", "xbbg_ext_columns", "xbbg_ext_calculate"];
+declare const BLOOMBERG_TOOL_NAMES: readonly ["xbbg_bdp", "xbbg_bdh", "xbbg_bds", "xbbg_bdib", "xbbg_bdtick", "xbbg_check_entitlements", "xbbg_bql", "xbbg_bsrch", "xbbg_bqr", "xbbg_bflds", "xbbg_beqs", "xbbg_yas", "xbbg_preferreds", "xbbg_corporate_bonds", "xbbg_index_members", "xbbg_resolve_isins", "xbbg_issuer_isins", "xbbg_etf_holdings", "xbbg_stream_snapshot", "xbbg_mktbar_snapshot", "xbbg_depth_snapshot", "xbbg_ext_ticker", "xbbg_ext_futures", "xbbg_ext_cdx", "xbbg_ext_currency", "xbbg_ext_bql_builder", "xbbg_ext_chart_spec", "xbbg_ext_market_session", "xbbg_ext_yas_overrides", "xbbg_ext_constants", "xbbg_ext_columns", "xbbg_ext_calculate"];
 type BloombergToolName = (typeof BLOOMBERG_TOOL_NAMES)[number];
 interface BloombergToolsOptions {
     readonly engine?: XbbgEngineLike;
@@ -51,6 +69,7 @@ declare function createBdhTool(options?: BloombergToolsOptions): BloombergTool;
 declare function createBdsTool(options?: BloombergToolsOptions): BloombergTool;
 declare function createBdibTool(options?: BloombergToolsOptions): BloombergTool;
 declare function createBdtickTool(options?: BloombergToolsOptions): BloombergTool;
+declare function createCheckEntitlementsTool(options?: BloombergToolsOptions): BloombergTool;
 declare function createBqlTool(options?: BloombergToolsOptions): BloombergTool;
 declare function createBsrchTool(options?: BloombergToolsOptions): BloombergTool;
 declare function createBqrTool(options?: BloombergToolsOptions): BloombergTool;
@@ -75,7 +94,7 @@ interface BloombergToolInstructionsOptions {
 }
 declare function getBloombergToolInstructions(options?: BloombergToolInstructionsOptions): string;
 
-declare const BLOOMBERG_EXT_TOOL_NAMES: readonly ("xbbg_bdp" | "xbbg_bdh" | "xbbg_bds" | "xbbg_bdib" | "xbbg_bdtick" | "xbbg_bql" | "xbbg_bsrch" | "xbbg_bqr" | "xbbg_bflds" | "xbbg_beqs" | "xbbg_yas" | "xbbg_preferreds" | "xbbg_corporate_bonds" | "xbbg_index_members" | "xbbg_resolve_isins" | "xbbg_issuer_isins" | "xbbg_etf_holdings" | "xbbg_stream_snapshot" | "xbbg_mktbar_snapshot" | "xbbg_depth_snapshot" | "xbbg_ext_ticker" | "xbbg_ext_futures" | "xbbg_ext_cdx" | "xbbg_ext_currency" | "xbbg_ext_bql_builder" | "xbbg_ext_chart_spec" | "xbbg_ext_market_session" | "xbbg_ext_yas_overrides" | "xbbg_ext_constants" | "xbbg_ext_columns" | "xbbg_ext_calculate")[];
+declare const BLOOMBERG_EXT_TOOL_NAMES: readonly ("xbbg_bdp" | "xbbg_bdh" | "xbbg_bds" | "xbbg_bdib" | "xbbg_bdtick" | "xbbg_check_entitlements" | "xbbg_bql" | "xbbg_bsrch" | "xbbg_bqr" | "xbbg_bflds" | "xbbg_beqs" | "xbbg_yas" | "xbbg_preferreds" | "xbbg_corporate_bonds" | "xbbg_index_members" | "xbbg_resolve_isins" | "xbbg_issuer_isins" | "xbbg_etf_holdings" | "xbbg_stream_snapshot" | "xbbg_mktbar_snapshot" | "xbbg_depth_snapshot" | "xbbg_ext_ticker" | "xbbg_ext_futures" | "xbbg_ext_cdx" | "xbbg_ext_currency" | "xbbg_ext_bql_builder" | "xbbg_ext_chart_spec" | "xbbg_ext_market_session" | "xbbg_ext_yas_overrides" | "xbbg_ext_constants" | "xbbg_ext_columns" | "xbbg_ext_calculate")[];
 declare function createExtTickerTool(options?: BloombergToolsOptions): BloombergTool;
 declare function createExtFuturesTool(options?: BloombergToolsOptions): BloombergTool;
 declare function createExtCdxTool(options?: BloombergToolsOptions): BloombergTool;
@@ -176,4 +195,4 @@ interface ChartSpecOutput {
 
 declare function createAllBloombergTools(options?: BloombergToolsOptions): BloombergTool[];
 
-export { BLOOMBERG_EXT_TOOL_NAMES, BLOOMBERG_TOOL_INSTRUCTIONS, BLOOMBERG_TOOL_NAMES, type BloombergChartSource, type BloombergTool, type BloombergToolInstructionsOptions, type BloombergToolName, type BloombergToolsOptions, type ChartKind, type ChartRenderer, type ChartRow, type ChartScalar, type ChartSpecInput, type ChartSpecOutput, type ChartSpecSummary, DEFAULT_ENGINE_REQUEST_TIMEOUT_MS, type NormalizedBloombergToolsOptions, type ToolEnvelope, type ToolInvocationConfig, type VegaLiteSpec, createAllBloombergTools, createBdhTool, createBdibTool, createBdpTool, createBdsTool, createBdtickTool, createBeqsTool, createBfldsTool, createBloombergExtTools, createBloombergTools, createBqlTool, createBqrTool, createBsrchTool, createCorporateBondsTool, createDepthSnapshotTool, createEtfHoldingsTool, createExtBqlBuilderTool, createExtCalculateTool, createExtCdxTool, createExtChartSpecTool, createExtColumnsTool, createExtConstantsTool, createExtCurrencyTool, createExtFuturesTool, createExtMarketSessionTool, createExtTickerTool, createExtYasOverridesTool, createIndexMembersTool, createIssuerIsinsTool, createMktbarSnapshotTool, createPreferredsTool, createResolveIsinsTool, createStreamSnapshotTool, createYasTool, getBloombergToolInstructions, toolParameterJsonSchema };
+export { BLOOMBERG_EXT_TOOL_NAMES, BLOOMBERG_TOOL_INSTRUCTIONS, BLOOMBERG_TOOL_NAMES, type BloombergChartSource, type BloombergTool, type BloombergToolInstructionsOptions, type BloombergToolName, type BloombergToolsOptions, type ChartKind, type ChartRenderer, type ChartRow, type ChartScalar, type ChartSpecInput, type ChartSpecOutput, type ChartSpecSummary, DEFAULT_ENGINE_REQUEST_TIMEOUT_MS, type NormalizedBloombergToolsOptions, type ToolEnvelope, type ToolInvocationConfig, type VegaLiteSpec, createAllBloombergTools, createBdhTool, createBdibTool, createBdpTool, createBdsTool, createBdtickTool, createBeqsTool, createBfldsTool, createBloombergExtTools, createBloombergTools, createBqlTool, createBqrTool, createBsrchTool, createCheckEntitlementsTool, createCorporateBondsTool, createDepthSnapshotTool, createEtfHoldingsTool, createExtBqlBuilderTool, createExtCalculateTool, createExtCdxTool, createExtChartSpecTool, createExtColumnsTool, createExtConstantsTool, createExtCurrencyTool, createExtFuturesTool, createExtMarketSessionTool, createExtTickerTool, createExtYasOverridesTool, createIndexMembersTool, createIssuerIsinsTool, createMktbarSnapshotTool, createPreferredsTool, createResolveIsinsTool, createStreamSnapshotTool, createYasTool, getBloombergToolInstructions, toolParameterJsonSchema };

package/dist/index.js

@@ -31,6 +31,7 @@ var BLOOMBERG_TOOL_NAMES = [
   "xbbg_bds",
   "xbbg_bdib",
   "xbbg_bdtick",
+  "xbbg_check_entitlements",
   "xbbg_bql",
   "xbbg_bsrch",
   "xbbg_bqr",
@@ -178,6 +179,11 @@ function createCoreResolver(options = {}) {
 
 // src/result-limits.ts
 var MAX_RESULT_DEPTH = 32;
+var MAX_ENTITLEMENT_EIDS = 1e4;
+var MAX_BLOOMBERG_EID = 2147483647;
+var MAX_EID_SECURITIES = 1e3;
+var MAX_EID_SECURITY_NAME_BYTES = 65536;
+var UTF8_ENCODER = new TextEncoder();
 function isPlainObject(value) {
   const prototype = Object.getPrototypeOf(value);
   return prototype === Object.prototype || prototype === null;
@@ -189,6 +195,97 @@ function truncateString(value, maxStringChars, state) {
   state.truncated = true;
   return `${value.slice(0, maxStringChars)}\u2026[truncated ${value.length - maxStringChars} chars]`;
 }
+function arrayMetadata(value) {
+  const metadata = {};
+  for (const [key, entry] of Object.entries(value)) {
+    if (!/^(?:0|[1-9]\d*)$/u.test(key)) {
+      metadata[key] = entry;
+    }
+  }
+  return metadata;
+}
+function limitEidData(value, maxStringChars, state, depth, seen) {
+  if (typeof value !== "object" || value === null || !isPlainObject(value)) {
+    state.truncated = true;
+    return {
+      data: {},
+      truncation: {
+        invalidSecurityCount: 1,
+        omittedSecurityCount: 0,
+        retainedEidCount: 0,
+        retainedSecurityCount: 0,
+        securityCounts: [],
+        totalEidCount: 0,
+        totalSecurityCount: 1
+      }
+    };
+  }
+  const data = /* @__PURE__ */ Object.create(null);
+  const securityCounts = [];
+  const entries = Object.entries(value);
+  let retainedEidCount = 0;
+  let retainedSecurityCount = 0;
+  let retainedSecurityNameBytes = 0;
+  let totalEidCount = 0;
+  let invalidSecurityCount = 0;
+  for (const [security, eids] of entries) {
+    if (!Array.isArray(eids)) {
+      state.truncated = true;
+      invalidSecurityCount += 1;
+      continue;
+    }
+    let validEids = true;
+    for (let index = 0; index < eids.length; index += 1) {
+      const eid = eids[index];
+      if (!Object.hasOwn(eids, index) || typeof eid !== "number" || !Number.isInteger(eid) || eid <= 0 || eid > MAX_BLOOMBERG_EID) {
+        validEids = false;
+        break;
+      }
+    }
+    if (!validEids) {
+      state.truncated = true;
+      invalidSecurityCount += 1;
+      continue;
+    }
+    const originalCount = eids.length;
+    totalEidCount += originalCount;
+    const securityNameBytes = UTF8_ENCODER.encode(security).byteLength;
+    const canRetainSecurity = retainedSecurityCount < MAX_EID_SECURITIES && retainedSecurityNameBytes + securityNameBytes <= MAX_EID_SECURITY_NAME_BYTES;
+    if (!canRetainSecurity) {
+      state.truncated = true;
+      continue;
+    }
+    retainedSecurityCount += 1;
+    retainedSecurityNameBytes += securityNameBytes;
+    const remainingEidCapacity = Math.max(0, MAX_ENTITLEMENT_EIDS - retainedEidCount);
+    const retained = eids.slice(0, remainingEidCapacity);
+    retainedEidCount += retained.length;
+    data[security] = limitValue(retained, MAX_ENTITLEMENT_EIDS, maxStringChars, state, depth, seen);
+    securityCounts.push({
+      originalCount,
+      retainedCount: retained.length
+    });
+    if (retained.length !== originalCount) {
+      state.truncated = true;
+    }
+  }
+  const omittedSecurityCount = entries.length - retainedSecurityCount - invalidSecurityCount;
+  const wasTruncated = retainedSecurityCount !== entries.length || retainedEidCount !== totalEidCount || invalidSecurityCount > 0;
+  return {
+    data,
+    ...wasTruncated ? {
+      truncation: {
+        invalidSecurityCount,
+        omittedSecurityCount,
+        retainedEidCount,
+        retainedSecurityCount,
+        securityCounts,
+        totalEidCount,
+        totalSecurityCount: entries.length
+      }
+    } : {}
+  };
+}
 function limitValue(value, maxRows, maxStringChars, state, depth = 0, seen = /* @__PURE__ */ new WeakSet()) {
   if (typeof value === "string") {
     return truncateString(value, maxStringChars, state);
@@ -210,7 +307,26 @@ function limitValue(value, maxRows, maxStringChars, state, depth = 0, seen = /*
     if (capped.length !== value.length) {
       state.truncated = true;
     }
-    return capped.map((item) => limitValue(item, maxRows, maxStringChars, state, depth + 1, seen));
+    const rows = capped.map(
+      (item) => limitValue(item, maxRows, maxStringChars, state, depth + 1, seen)
+    );
+    const metadata = arrayMetadata(value);
+    if (Object.keys(metadata).length === 0) {
+      return rows;
+    }
+    const output = { rows };
+    for (const [key, entry] of Object.entries(metadata)) {
+      if (key === "eidData") {
+        const limited = limitEidData(entry, maxStringChars, state, depth + 1, seen);
+        output.eidData = limited.data;
+        if (limited.truncation !== void 0) {
+          output.eidDataTruncation = limited.truncation;
+        }
+        continue;
+      }
+      output[key] = limitValue(entry, maxRows, maxStringChars, state, depth + 1, seen);
+    }
+    return output;
   }
   if (typeof value === "object" && value !== null) {
     if (seen.has(value)) {
@@ -841,6 +957,7 @@ var REQUIRED_TOOL_INSTRUCTIONS = [
   "- xbbg_bds: Bloomberg bulk/table fields. Provide exactly one bulk field; do not use bds for ordinary multi-field reference data.",
   "- xbbg_bdib: intraday bars only. Provide one ticker, explicit ISO start/end datetimes with time components, a positive interval in minutes, and timezone context when datetimes are naive.",
   "- xbbg_bdtick: intraday tick data. Provide one ticker, explicit ISO start/end datetimes with time components, and explicit eventTypes unless the default event stream is intended. Use includeBrokerCodes or includeConditionCodes only when those columns are needed.",
+  "- xbbg_check_entitlements: checks whether the current Bloomberg identity is entitled to a nonempty list of EIDs returned by an EID-capable request. Usually use the default //blp/refdata service.",
   "- xbbg_bql: BQL expressions only when the user asks for BQL or the request is naturally expressed as a bounded BQL query. Keep queries short, explicit, and scoped to the requested universe.",
   "- xbbg_bsrch: Bloomberg search-grid or saved-search workflows only. Do not use it for ordinary security lookup.",
   "- xbbg_bqr: Bloomberg Quote Request / dealer quotes. Prefer fixed-income identifier inputs with a dealer quote source such as /isin/<ISIN>@<QUOTE_SOURCE> <MARKET_SECTOR>, explicit start/end datetimes with time components, and explicit event types.",
@@ -912,6 +1029,7 @@ var BDH_DESCRIPTION = 'Bloomberg historical time series. Requires explicit start
 var BDS_DESCRIPTION = 'Bloomberg bulk/table reference data. Requires exactly one bulk field, not a field list. Use /isin/<ISIN> for ISINs and /cusip/<CUSIP> for CUSIPs. Example: securities ["<INDEX_TICKER> <MARKET_SECTOR>"], field "<BULK_FIELD>".';
 var BDIB_DESCRIPTION = 'Bloomberg intraday bars. Requires one ticker plus explicit ISO start/end datetimes with time components and a positive interval in minutes. Use /isin/<ISIN> for ISINs and /cusip/<CUSIP> for CUSIPs. Example: ticker "<TICKER> <MARKET_SECTOR>", start "<START_DATETIME>", end "<END_DATETIME>", interval <MINUTES>.';
 var BDTICK_DESCRIPTION = 'Bloomberg intraday tick data. Requires one ticker plus explicit ISO start/end datetimes with time components. Set eventTypes explicitly, for example ["<EVENT_TYPE>"], and includeBrokerCodes/includeConditionCodes only when needed.';
+var CHECK_ENTITLEMENTS_DESCRIPTION = "Check the current Bloomberg identity against entitlement IDs returned by a request with returnEids enabled. Accepts a nonempty integer EID list and defaults the service to //blp/refdata. This tool is read-only.";
 var BQL_DESCRIPTION = "Bloomberg Query Language expression sent as one complete query string. Use for bounded universe analytics with placeholder-shaped syntax such as get(<FIELD>) for('<TICKER> <MARKET_SECTOR>'), holdings('<ETF_TICKER> <MARKET_SECTOR>'), members('<INDEX_TICKER> <MARKET_SECTOR>'), filters with with(...), or dates=range(...). Prefer xbbg_bdp/xbbg_bdh for simple reference or historical requests.";
 var BSRCH_DESCRIPTION = 'Bloomberg search/grid request. Use for saved-search or ExcelGetGrid-style Bloomberg searches, not ordinary security lookup. Example searchSpec "<SEARCH_SPEC>".';
 var BQR_DESCRIPTION = 'Bloomberg Quote Request / dealer quotes. Use for fixed-income dealer quote ticks, preferably with an ISIN plus dealer source such as "/isin/<ISIN>@<QUOTE_SOURCE> <MARKET_SECTOR>"; requires explicit ISO start/end datetimes with time components. Set eventTypes explicitly, for example ["<EVENT_TYPE>"].';
@@ -1948,6 +2066,7 @@ function createBdpSchema(options) {
     overrides: overridesMap(tool2, "overrides").describe(
       "Bloomberg field overrides. Use primitive values for global overrides and nested primitive maps keyed by exact security for per-security overrides."
     ),
+    returnEids: z__namespace.boolean().optional().describe("Request Bloomberg entitlement IDs and retain them in result metadata."),
     securities: stringArray2(
       tool2,
       "securities",
@@ -1990,6 +2109,7 @@ function createBdhSchema(options) {
       "Securities exactly as the user supplied them: '<TICKER> <MARKET_SECTOR>' for Bloomberg tickers, '/isin/<ISIN>' for raw ISINs, '/cusip/<CUSIP>' for raw CUSIPs. Never invent, guess, or convert identifiers into tickers."
     ),
     start: dateField(tool2, "start").describe("Required start date. Use YYYY-MM-DD or YYYYMMDD."),
+    returnEids: z__namespace.boolean().optional().describe("Request Bloomberg entitlement IDs and retain them in result metadata."),
     validateFields: z__namespace.boolean().optional().describe("Override field validation for this request.")
   }).superRefine((value, ctx) => {
     if (value.start > value.end) {
@@ -2013,6 +2133,7 @@ function createBdsSchema(options) {
     overrides: overridesMap(tool2, "overrides").describe(
       "Bloomberg overrides. Use primitive values for global overrides and nested primitive maps keyed by exact security for per-security overrides."
     ),
+    returnEids: z__namespace.boolean().optional().describe("Request Bloomberg entitlement IDs and retain them in result metadata."),
     securities: stringArray2(
       tool2,
       "securities",
@@ -2038,6 +2159,7 @@ function createBdibSchema(options) {
     ),
     outputTz: nonEmptyString2(tool2, "outputTz", options.maxStringChars, "<TIMEZONE>").optional().describe("Optional output timezone."),
     requestTz: nonEmptyString2(tool2, "requestTz", options.maxStringChars, "<TIMEZONE>").optional().describe("Timezone for naive start/end datetimes."),
+    returnEids: z__namespace.boolean().optional().describe("Request Bloomberg entitlement IDs and retain them in result metadata."),
     start: dateTimeField(tool2, "start").describe(
       "Required intraday start datetime. Use ISO 8601 with timezone when possible."
     ),
@@ -2077,6 +2199,7 @@ function createBdtickSchema(options) {
     ),
     outputTz: nonEmptyString2(tool2, "outputTz", options.maxStringChars, "<TIMEZONE>").optional().describe("Optional output timezone."),
     requestTz: nonEmptyString2(tool2, "requestTz", options.maxStringChars, "<TIMEZONE>").optional().describe("Timezone for naive start/end datetimes."),
+    returnEids: z__namespace.boolean().optional().describe("Request Bloomberg entitlement IDs and retain them in result metadata."),
     start: dateTimeField(tool2, "start").describe(
       "Required intraday tick start datetime. Use ISO 8601 with timezone when possible."
     ),
@@ -2090,6 +2213,18 @@ function createBdtickSchema(options) {
     )
   });
 }
+function createCheckEntitlementsSchema(options) {
+  const tool2 = "xbbg_check_entitlements";
+  return z__namespace.object({
+    eids: z__namespace.array(
+      z__namespace.number().int(`${tool2}: eids must contain integers only.`).positive(`${tool2}: eids must contain positive integers only.`).max(MAX_BLOOMBERG_EID, `${tool2}: eids must be signed 32-bit integers.`)
+    ).nonempty(`${tool2}: eids must contain at least one entitlement ID.`).max(
+      MAX_ENTITLEMENT_EIDS,
+      `${tool2}: eids must contain at most ${String(MAX_ENTITLEMENT_EIDS)} values.`
+    ).describe("Nonempty list of positive signed 32-bit Bloomberg entitlement IDs."),
+    service: nonEmptyString2(tool2, "service", options.maxStringChars, "//blp/refdata").optional().default("//blp/refdata").describe("Bloomberg service to check. Defaults to //blp/refdata.")
+  });
+}
 function createBqlSchema(options) {
   const tool2 = "xbbg_bql";
   return z__namespace.object({
@@ -2557,7 +2692,8 @@ function bdpWithResolver(resolver) {
           includeSecurityErrors: input.includeSecurityErrors,
           kwargs: input.kwargs,
           overrides: input.overrides,
-          validateFields: validationSetting(resolver, input.validateFields)
+          validateFields: validationSetting(resolver, input.validateFields),
+          returnEids: input.returnEids
         };
         const result = await engine.bdp(input.securities, input.fields, options);
         return resultString2(resolver, name, result);
@@ -2586,6 +2722,7 @@ function bdhWithResolver(resolver) {
           kwargs: input.kwargs,
           overrides: input.overrides,
           start: input.start,
+          returnEids: input.returnEids,
           validateFields: validationSetting(resolver, input.validateFields)
         };
         const result = await engine.bdh(input.securities, input.fields, options);
@@ -2612,6 +2749,7 @@ function bdsWithResolver(resolver) {
           backend: "json",
           kwargs: input.kwargs,
           overrides: input.overrides,
+          returnEids: input.returnEids,
           validateFields: validationSetting(resolver, input.validateFields)
         };
         const result = await engine.bds(input.securities, [input.field], options);
@@ -2642,6 +2780,7 @@ function bdibWithResolver(resolver) {
           kwargs: input.kwargs,
           outputTz: input.outputTz,
           requestTz: input.requestTz,
+          returnEids: input.returnEids,
           start: input.start
         });
         return resultString2(resolver, name, result);
@@ -2677,6 +2816,7 @@ function bdtickWithResolver(resolver) {
           kwargs: input.kwargs,
           outputTz: input.outputTz,
           requestTz: input.requestTz,
+          returnEids: input.returnEids,
           start: input.start
         });
         return resultString2(resolver, name, result);
@@ -2692,6 +2832,31 @@ function bdtickWithResolver(resolver) {
     }
   );
 }
+function checkEntitlementsWithResolver(resolver) {
+  const name = "xbbg_check_entitlements";
+  return createBloombergStructuredTool(
+    async (input) => {
+      try {
+        const engine = await resolver.getEngine();
+        const result = await engine.checkEntitlements(input.service ?? "//blp/refdata", input.eids);
+        return createToolResult(
+          name,
+          result,
+          MAX_ENTITLEMENT_EIDS,
+          resolver.options.maxStringChars
+        );
+      } catch (error) {
+        throwWithToolContext(name, error);
+      }
+    },
+    {
+      description: CHECK_ENTITLEMENTS_DESCRIPTION,
+      name,
+      responseFormat: "content_and_artifact",
+      schema: createCheckEntitlementsSchema(resolver.options)
+    }
+  );
+}
 function bqlWithResolver(resolver) {
   const name = "xbbg_bql";
   return createBloombergStructuredTool(
@@ -3064,6 +3229,9 @@ function createBdibTool(options = {}) {
 function createBdtickTool(options = {}) {
   return bdtickWithResolver(createCoreResolver(options));
 }
+function createCheckEntitlementsTool(options = {}) {
+  return checkEntitlementsWithResolver(createCoreResolver(options));
+}
 function createBqlTool(options = {}) {
   return bqlWithResolver(createCoreResolver(options));
 }
@@ -3115,6 +3283,7 @@ var CORE_TOOL_DEFINITIONS = Object.freeze([
   { create: bdsWithResolver, name: "xbbg_bds" },
   { create: bdibWithResolver, name: "xbbg_bdib" },
   { create: bdtickWithResolver, name: "xbbg_bdtick" },
+  { create: checkEntitlementsWithResolver, name: "xbbg_check_entitlements" },
   { create: bqlWithResolver, name: "xbbg_bql" },
   { create: bsrchWithResolver, name: "xbbg_bsrch" },
   { create: bqrWithResolver, name: "xbbg_bqr" },
@@ -3166,6 +3335,7 @@ exports.createBloombergTools = createBloombergTools;
 exports.createBqlTool = createBqlTool;
 exports.createBqrTool = createBqrTool;
 exports.createBsrchTool = createBsrchTool;
+exports.createCheckEntitlementsTool = createCheckEntitlementsTool;
 exports.createCorporateBondsTool = createCorporateBondsTool;
 exports.createDepthSnapshotTool = createDepthSnapshotTool;
 exports.createEtfHoldingsTool = createEtfHoldingsTool;