@ellipsis-dev/sdk 0.16.0 → 0.17.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ellipsis-dev/sdk",
-  "version": "0.16.0",
+  "version": "0.17.0",
   "description": "TypeScript SDK for the Ellipsis agents platform: /v1 REST types + client, the session stream WebSocket client, and the session transcript store.",
   "license": "MIT",
   "type": "module",

package/schema/frames.schema.json

@@ -39,7 +39,6 @@
           "default": {
             "description": null,
             "enabled": true,
-            "interactive": true,
             "metadata": {
               "annotations": {},
               "labels": []
@@ -49,7 +48,14 @@
           }
         },
         "environment": {
-          "$ref": "#/$defs/AgentConfigEnvironment",
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "$ref": "#/$defs/AgentConfigEnvironment"
+            }
+          ],
           "default": {
             "compute": {
               "cpu": null,
@@ -64,9 +70,11 @@
               "dockerfile_append": null,
               "setup": null
             },
+            "mcp_servers": [],
             "repositories": [],
             "variables": []
-          }
+          },
+          "title": "Environment"
         },
         "input": {
           "anyOf": [
@@ -79,21 +87,6 @@
           ],
           "default": null
         },
-        "mcp_servers": {
-          "default": [],
-          "items": {
-            "anyOf": [
-              {
-                "type": "string"
-              },
-              {
-                "$ref": "#/$defs/AgentConfigMcpServer"
-              }
-            ]
-          },
-          "title": "Mcp Servers",
-          "type": "array"
-        },
         "output": {
           "anyOf": [
             {
@@ -161,7 +154,6 @@
         "ellipsis",
         "environment",
         "input",
-        "mcp_servers",
         "output",
         "permissions",
         "skills",
@@ -497,7 +489,7 @@
     },
     "AgentConfigEllipsis": {
       "additionalProperties": false,
-      "description": "The Ellipsis product namespace for a config file: which schema this is\n(`version`), the human-facing identity (`name`/`description`), freeform\norganizational `metadata`, whether the agent is `enabled`, and the\nhuman-access flag `interactive`. The presence of a top-level `ellipsis:`\nmapping is what marks a YAML file as an Ellipsis agent config (vs arbitrary\nYAML that merely lives under a config directory) \u2014 see\n`yaml_is_ellipsis_config`.\n\n`enabled`/`interactive` are agent behavior, not freeform metadata, so they\nstay inside the config `sha` (only `metadata` is sha-excluded).\n`interactive` lets a human `agent session connect` to a live session (CLI\nrelay). It does not decide whether a session is ephemeral or durable \u2014 that\nis the trigger's job.",
+      "description": "The Ellipsis product namespace for a config file: which schema this is\n(`version`), the human-facing identity (`name`/`description`), freeform\norganizational `metadata`, and whether the agent is `enabled`. The\npresence of a top-level `ellipsis:` mapping is what marks a YAML file as\nan Ellipsis agent config (vs arbitrary YAML that merely lives under a\nconfig directory) \u2014 see `yaml_is_ellipsis_config`.\n\n`enabled` is agent behavior, not freeform metadata, so it stays inside\nthe config `sha` (only `metadata` is sha-excluded). Whether a session\naccepts messages is a per-run choice (POST /v1/sessions `interactive`),\nnot a config one.",
       "properties": {
         "description": {
           "anyOf": [
@@ -516,11 +508,6 @@
           "title": "Enabled",
           "type": "boolean"
         },
-        "interactive": {
-          "default": true,
-          "title": "Interactive",
-          "type": "boolean"
-        },
         "metadata": {
           "$ref": "#/$defs/AgentConfigMetadata",
           "default": {
@@ -549,7 +536,6 @@
       "required": [
         "description",
         "enabled",
-        "interactive",
         "metadata",
         "name",
         "version"
@@ -614,6 +600,27 @@
             "setup": null
           }
         },
+        "mcp_servers": {
+          "default": [],
+          "items": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "$ref": "#/$defs/AgentConfigMcpServer"
+              },
+              {
+                "$ref": "#/$defs/AgentConfigMcpStdioServer"
+              },
+              {
+                "$ref": "#/$defs/AgentConfigMcpRemoteServer"
+              }
+            ]
+          },
+          "title": "Mcp Servers",
+          "type": "array"
+        },
         "repositories": {
           "default": [],
           "items": {
@@ -635,6 +642,7 @@
         "compute",
         "hooks",
         "image",
+        "mcp_servers",
         "repositories",
         "variables"
       ],
@@ -824,9 +832,38 @@
       "title": "AgentConfigInput",
       "type": "object"
     },
+    "AgentConfigMcpRemoteServer": {
+      "additionalProperties": false,
+      "description": "A bring-your-own remote MCP server: the harness talks HTTP to `url`.\nNothing runs in the sandbox image. `headers` carry static auth (e.g.\n`Authorization: Bearer ${TOKEN}`); values may embed `${NAME}` secret\nreferences, resolved at run time from the account's secrets store.",
+      "properties": {
+        "headers": {
+          "additionalProperties": {
+            "type": "string"
+          },
+          "default": {},
+          "title": "Headers",
+          "type": "object"
+        },
+        "name": {
+          "title": "Name",
+          "type": "string"
+        },
+        "url": {
+          "title": "Url",
+          "type": "string"
+        }
+      },
+      "required": [
+        "headers",
+        "name",
+        "url"
+      ],
+      "title": "AgentConfigMcpRemoteServer",
+      "type": "object"
+    },
     "AgentConfigMcpServer": {
       "additionalProperties": false,
-      "description": "One built-in MCP server this agent opts into by name (`linear`/`slack`).\nThis is a name reference over the connected built-in set, NOT a custom-server\ndefinition \u2014 there is no command/url/headers shape (that was the old,\nremoved field, and Ellipsis does not support bring-your-own MCP servers).\nIt only matters when the named integration is set to `opt_in` inclusion; an\nintegration in the default `all_sessions` mode is added regardless.",
+      "description": "One built-in MCP server this agent opts into by name (`linear`/`slack`).\nA name reference over the connected built-in set \u2014 the platform manages the\nserver's transport and credentials. It only matters when the named\nintegration is set to `opt_in` inclusion; an integration in the default\n`all_sessions` mode is added regardless. For a server the platform does not\nprovide, define it instead (`AgentConfigMcpStdioServer` /\n`AgentConfigMcpRemoteServer`).",
       "properties": {
         "name": {
           "title": "Name",
@@ -839,6 +876,44 @@
       "title": "AgentConfigMcpServer",
       "type": "object"
     },
+    "AgentConfigMcpStdioServer": {
+      "additionalProperties": false,
+      "description": "A bring-your-own stdio MCP server: the harness spawns `command` inside\nthe sandbox and speaks JSON-RPC over its stdin/stdout. The command must be\nrunnable in the sandbox image \u2014 install its runtime via `image.setup` /\n`image.dockerfile_append` if the base image lacks it.\n\n`env` values may embed `${NAME}` references, resolved at run time from the\naccount's secrets store (see `mcp_secret_refs`); everything else is passed\nliterally.",
+      "properties": {
+        "args": {
+          "default": [],
+          "items": {
+            "type": "string"
+          },
+          "title": "Args",
+          "type": "array"
+        },
+        "command": {
+          "title": "Command",
+          "type": "string"
+        },
+        "env": {
+          "additionalProperties": {
+            "type": "string"
+          },
+          "default": {},
+          "title": "Env",
+          "type": "object"
+        },
+        "name": {
+          "title": "Name",
+          "type": "string"
+        }
+      },
+      "required": [
+        "args",
+        "command",
+        "env",
+        "name"
+      ],
+      "title": "AgentConfigMcpStdioServer",
+      "type": "object"
+    },
     "AgentConfigMemorySize": {
       "additionalProperties": false,
       "description": "A memory size as explicit units, summed (binary: 1GB = 1024MB = 1024MiB).\nSet any of `gb`/`mb` (at least one). The alternative to the `8GB`-style\nshorthand string.",
@@ -2526,6 +2601,18 @@
       "title": "EllipsisGrant",
       "type": "object"
     },
+    "EnvironmentSource": {
+      "description": "How a session's environment was chosen. None (the field is nullable)\nwhen the config carried an inline environment block and no resolution ran \u2014\nan inline environment is not a reference, so there is nothing to record.\n\nNot derivable from the row: `environment_id` says WHICH environment, not\nhow it was chosen, and is null for the built-in basic sandbox.",
+      "enum": [
+        "request",
+        "agent_config",
+        "repo_default",
+        "account_default",
+        "platform_default"
+      ],
+      "title": "EnvironmentSource",
+      "type": "string"
+    },
     "ErrorFrame": {
       "description": "Terminal error marker, sent before the server closes with code 1011.",
       "properties": {
@@ -3191,6 +3278,7 @@
         "reviews",
         "configs",
         "defaults",
+        "environments",
         "secrets",
         "templates",
         "integrations",
@@ -4024,6 +4112,10 @@
           "title": "Created At",
           "type": "string"
         },
+        "environment": {
+          "$ref": "#/$defs/SessionEnvironment",
+          "description": "The environment the session resolved: the saved environment's id and how it was chosen. The environment's frozen body is inside agent.config.environment."
+        },
         "exit_status": {
           "anyOf": [
             {
@@ -4194,6 +4286,7 @@
         "context_repository",
         "cost",
         "created_at",
+        "environment",
         "exit_status",
         "git",
         "harness",
@@ -4380,6 +4473,42 @@
       "title": "SessionCost",
       "type": "object"
     },
+    "SessionEnvironment": {
+      "description": "The environment this session resolved: which saved environment (as it\nexists now) and how it was chosen. The environment's frozen BODY rides\ninside `agent.config.environment` \u2014 substitution happens before the config\nsnapshot freezes \u2014 so this object is provenance, not payload.",
+      "properties": {
+        "environment_id": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "default": null,
+          "description": "Identifier of the saved environment the session's config resolved. Null for an inline environment block or the built-in basic sandbox.",
+          "title": "Environment Id"
+        },
+        "source": {
+          "anyOf": [
+            {
+              "$ref": "#/$defs/EnvironmentSource"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "default": null,
+          "description": "How the environment was chosen (request, agent_config, repo_default, account_default, platform_default). Null when the config carried its own inline environment."
+        }
+      },
+      "required": [
+        "environment_id",
+        "source"
+      ],
+      "title": "SessionEnvironment",
+      "type": "object"
+    },
     "SessionExitStatus": {
       "description": "Why a terminal agent session ended \u2014 a finer-grained reason than `status`.\n\n`status` (SessionStatus) is the lifecycle state: COMPLETED / ERROR /\nCANCELLED. `exit_status` explains *why* a run reached that terminal state, so\nthe UI and metrics can tell a budget cutoff apart from a crashed tool call or\na deliberate cancellation. It is None until the run reaches a terminal state.",
       "enum": [