@statelyai/mcp 0.8.3 → 0.8.6

package/dist/index.d.cts

@@ -169,7 +169,26 @@ type StatelyMcpServerOptions = {
    * Omitted by default; observer failures never affect tool results.
    */
   onToolCall?: StatelyMcpToolCallObserver;
+  /**
+   * How this server identifies itself to the analysis API, sent as
+   * `x-stately-client` on every `callApi` request.
+   *
+   * The tools are HTTP calls against `apiBaseUrl`, so the API is the only
+   * place local usage can be counted — but a request from the stdio binary
+   * and a request from a hosted server are otherwise indistinguishable there.
+   * This header is the distinction, and it carries no user or machine content.
+   *
+   * A customer running the analysis API inside their own network sends this
+   * to their own deployment and nothing reaches us, which is the intended
+   * behaviour, not a gap.
+   */
+  clientId?: string;
 };
+/** Sent when the host does not identify itself; see `clientId`. */
+declare const DEFAULT_CLIENT_ID = "stately-mcp/embedded";
+/** Sent by the `stately-mcp` stdio binary. */
+declare const STDIO_CLIENT_ID = "stately-mcp/stdio";
+declare const CLIENT_ID_HEADER = "x-stately-client";
 type StatelyCredential = {
   type: 'api_key';
   token: string;
@@ -228,4 +247,4 @@ declare function getDefaultCredential(): Promise<{
 } | undefined>;
 declare function createStatelyMcpServer$1(options?: StatelyMcpServerOptions): McpServer;
 //#endregion
-export { type HttpResourceClientOptions, type ResourceCallOptions, type ResourceClient, ResourceClientError, type ResourceClientResolver, type StatelyMcpServerOptions, type StatelyMcpToolCallEvent, type StatelyMcpToolCallObserver, type StatelyMcpToolName, type StatelyResourceToolOptions, createStatelyMcpServer as createHostedStatelyMcpServer, createHttpResourceClient, createStatelyMcpServer$1 as createStatelyMcpServer, formatForPath, getDefaultCredential, isCandidate, isResourceClientError, readOnlyAnnotations, readWorkspaceMachine, registerStatelyMcpTools, registerStatelyResourceTools, reportVisualizationRenderedToolName, resourceApiV1BaseUrl, resourceReadOnlyAnnotations, statelyMcpToolNames, visualizeMachineAppUri, walkWorkspace, workspaceFromArgv };
+export { CLIENT_ID_HEADER, DEFAULT_CLIENT_ID, type HttpResourceClientOptions, type ResourceCallOptions, type ResourceClient, ResourceClientError, type ResourceClientResolver, STDIO_CLIENT_ID, type StatelyMcpServerOptions, type StatelyMcpToolCallEvent, type StatelyMcpToolCallObserver, type StatelyMcpToolName, type StatelyResourceToolOptions, createStatelyMcpServer as createHostedStatelyMcpServer, createHttpResourceClient, createStatelyMcpServer$1 as createStatelyMcpServer, formatForPath, getDefaultCredential, isCandidate, isResourceClientError, readOnlyAnnotations, readWorkspaceMachine, registerStatelyMcpTools, registerStatelyResourceTools, reportVisualizationRenderedToolName, resourceApiV1BaseUrl, resourceReadOnlyAnnotations, statelyMcpToolNames, visualizeMachineAppUri, walkWorkspace, workspaceFromArgv };

package/dist/index.d.mts

@@ -169,7 +169,26 @@ type StatelyMcpServerOptions = {
    * Omitted by default; observer failures never affect tool results.
    */
   onToolCall?: StatelyMcpToolCallObserver;
+  /**
+   * How this server identifies itself to the analysis API, sent as
+   * `x-stately-client` on every `callApi` request.
+   *
+   * The tools are HTTP calls against `apiBaseUrl`, so the API is the only
+   * place local usage can be counted — but a request from the stdio binary
+   * and a request from a hosted server are otherwise indistinguishable there.
+   * This header is the distinction, and it carries no user or machine content.
+   *
+   * A customer running the analysis API inside their own network sends this
+   * to their own deployment and nothing reaches us, which is the intended
+   * behaviour, not a gap.
+   */
+  clientId?: string;
 };
+/** Sent when the host does not identify itself; see `clientId`. */
+declare const DEFAULT_CLIENT_ID = "stately-mcp/embedded";
+/** Sent by the `stately-mcp` stdio binary. */
+declare const STDIO_CLIENT_ID = "stately-mcp/stdio";
+declare const CLIENT_ID_HEADER = "x-stately-client";
 type StatelyCredential = {
   type: 'api_key';
   token: string;
@@ -228,4 +247,4 @@ declare function getDefaultCredential(): Promise<{
 } | undefined>;
 declare function createStatelyMcpServer$1(options?: StatelyMcpServerOptions): McpServer;
 //#endregion
-export { type HttpResourceClientOptions, type ResourceCallOptions, type ResourceClient, ResourceClientError, type ResourceClientResolver, type StatelyMcpServerOptions, type StatelyMcpToolCallEvent, type StatelyMcpToolCallObserver, type StatelyMcpToolName, type StatelyResourceToolOptions, createStatelyMcpServer as createHostedStatelyMcpServer, createHttpResourceClient, createStatelyMcpServer$1 as createStatelyMcpServer, formatForPath, getDefaultCredential, isCandidate, isResourceClientError, readOnlyAnnotations, readWorkspaceMachine, registerStatelyMcpTools, registerStatelyResourceTools, reportVisualizationRenderedToolName, resourceApiV1BaseUrl, resourceReadOnlyAnnotations, statelyMcpToolNames, visualizeMachineAppUri, walkWorkspace, workspaceFromArgv };
+export { CLIENT_ID_HEADER, DEFAULT_CLIENT_ID, type HttpResourceClientOptions, type ResourceCallOptions, type ResourceClient, ResourceClientError, type ResourceClientResolver, STDIO_CLIENT_ID, type StatelyMcpServerOptions, type StatelyMcpToolCallEvent, type StatelyMcpToolCallObserver, type StatelyMcpToolName, type StatelyResourceToolOptions, createStatelyMcpServer as createHostedStatelyMcpServer, createHttpResourceClient, createStatelyMcpServer$1 as createStatelyMcpServer, formatForPath, getDefaultCredential, isCandidate, isResourceClientError, readOnlyAnnotations, readWorkspaceMachine, registerStatelyMcpTools, registerStatelyResourceTools, reportVisualizationRenderedToolName, resourceApiV1BaseUrl, resourceReadOnlyAnnotations, statelyMcpToolNames, visualizeMachineAppUri, walkWorkspace, workspaceFromArgv };