@ellipsis-dev/sdk 0.16.0 → 0.18.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +118 -100
- package/dist/index.js +134 -94
- package/dist/store/index.d.ts +1 -1
- package/dist/stream/index.d.ts +1 -1
- package/dist/{types-DB1hOyQE.d.ts → types-BLSh1Px1.d.ts} +977 -591
- package/package.json +1 -1
- package/schema/frames.schema.json +168 -33
- package/schema/openapi.v1.json +1450 -923
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ellipsis-dev/sdk",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.18.0",
|
|
4
4
|
"description": "TypeScript SDK for the Ellipsis agents platform: /v1 REST types + client, the session stream WebSocket client, and the session transcript store.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
"effort": null,
|
|
19
19
|
"fallback_model": null,
|
|
20
20
|
"max_turns": null,
|
|
21
|
-
"model":
|
|
21
|
+
"model": null,
|
|
22
22
|
"settings": null,
|
|
23
23
|
"system": ""
|
|
24
24
|
}
|
|
@@ -39,7 +39,6 @@
|
|
|
39
39
|
"default": {
|
|
40
40
|
"description": null,
|
|
41
41
|
"enabled": true,
|
|
42
|
-
"interactive": true,
|
|
43
42
|
"metadata": {
|
|
44
43
|
"annotations": {},
|
|
45
44
|
"labels": []
|
|
@@ -49,7 +48,14 @@
|
|
|
49
48
|
}
|
|
50
49
|
},
|
|
51
50
|
"environment": {
|
|
52
|
-
"
|
|
51
|
+
"anyOf": [
|
|
52
|
+
{
|
|
53
|
+
"type": "string"
|
|
54
|
+
},
|
|
55
|
+
{
|
|
56
|
+
"$ref": "#/$defs/AgentConfigEnvironment"
|
|
57
|
+
}
|
|
58
|
+
],
|
|
53
59
|
"default": {
|
|
54
60
|
"compute": {
|
|
55
61
|
"cpu": null,
|
|
@@ -64,9 +70,11 @@
|
|
|
64
70
|
"dockerfile_append": null,
|
|
65
71
|
"setup": null
|
|
66
72
|
},
|
|
73
|
+
"mcp_servers": [],
|
|
67
74
|
"repositories": [],
|
|
68
75
|
"variables": []
|
|
69
|
-
}
|
|
76
|
+
},
|
|
77
|
+
"title": "Environment"
|
|
70
78
|
},
|
|
71
79
|
"input": {
|
|
72
80
|
"anyOf": [
|
|
@@ -79,21 +87,6 @@
|
|
|
79
87
|
],
|
|
80
88
|
"default": null
|
|
81
89
|
},
|
|
82
|
-
"mcp_servers": {
|
|
83
|
-
"default": [],
|
|
84
|
-
"items": {
|
|
85
|
-
"anyOf": [
|
|
86
|
-
{
|
|
87
|
-
"type": "string"
|
|
88
|
-
},
|
|
89
|
-
{
|
|
90
|
-
"$ref": "#/$defs/AgentConfigMcpServer"
|
|
91
|
-
}
|
|
92
|
-
]
|
|
93
|
-
},
|
|
94
|
-
"title": "Mcp Servers",
|
|
95
|
-
"type": "array"
|
|
96
|
-
},
|
|
97
90
|
"output": {
|
|
98
91
|
"anyOf": [
|
|
99
92
|
{
|
|
@@ -161,7 +154,6 @@
|
|
|
161
154
|
"ellipsis",
|
|
162
155
|
"environment",
|
|
163
156
|
"input",
|
|
164
|
-
"mcp_servers",
|
|
165
157
|
"output",
|
|
166
158
|
"permissions",
|
|
167
159
|
"skills",
|
|
@@ -271,9 +263,16 @@
|
|
|
271
263
|
"title": "Max Turns"
|
|
272
264
|
},
|
|
273
265
|
"model": {
|
|
274
|
-
"
|
|
275
|
-
|
|
276
|
-
|
|
266
|
+
"anyOf": [
|
|
267
|
+
{
|
|
268
|
+
"type": "string"
|
|
269
|
+
},
|
|
270
|
+
{
|
|
271
|
+
"type": "null"
|
|
272
|
+
}
|
|
273
|
+
],
|
|
274
|
+
"default": null,
|
|
275
|
+
"title": "Model"
|
|
277
276
|
},
|
|
278
277
|
"settings": {
|
|
279
278
|
"anyOf": [
|
|
@@ -497,7 +496,7 @@
|
|
|
497
496
|
},
|
|
498
497
|
"AgentConfigEllipsis": {
|
|
499
498
|
"additionalProperties": false,
|
|
500
|
-
"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
|
|
499
|
+
"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.",
|
|
501
500
|
"properties": {
|
|
502
501
|
"description": {
|
|
503
502
|
"anyOf": [
|
|
@@ -516,11 +515,6 @@
|
|
|
516
515
|
"title": "Enabled",
|
|
517
516
|
"type": "boolean"
|
|
518
517
|
},
|
|
519
|
-
"interactive": {
|
|
520
|
-
"default": true,
|
|
521
|
-
"title": "Interactive",
|
|
522
|
-
"type": "boolean"
|
|
523
|
-
},
|
|
524
518
|
"metadata": {
|
|
525
519
|
"$ref": "#/$defs/AgentConfigMetadata",
|
|
526
520
|
"default": {
|
|
@@ -549,7 +543,6 @@
|
|
|
549
543
|
"required": [
|
|
550
544
|
"description",
|
|
551
545
|
"enabled",
|
|
552
|
-
"interactive",
|
|
553
546
|
"metadata",
|
|
554
547
|
"name",
|
|
555
548
|
"version"
|
|
@@ -614,6 +607,27 @@
|
|
|
614
607
|
"setup": null
|
|
615
608
|
}
|
|
616
609
|
},
|
|
610
|
+
"mcp_servers": {
|
|
611
|
+
"default": [],
|
|
612
|
+
"items": {
|
|
613
|
+
"anyOf": [
|
|
614
|
+
{
|
|
615
|
+
"type": "string"
|
|
616
|
+
},
|
|
617
|
+
{
|
|
618
|
+
"$ref": "#/$defs/AgentConfigMcpServer"
|
|
619
|
+
},
|
|
620
|
+
{
|
|
621
|
+
"$ref": "#/$defs/AgentConfigMcpStdioServer"
|
|
622
|
+
},
|
|
623
|
+
{
|
|
624
|
+
"$ref": "#/$defs/AgentConfigMcpRemoteServer"
|
|
625
|
+
}
|
|
626
|
+
]
|
|
627
|
+
},
|
|
628
|
+
"title": "Mcp Servers",
|
|
629
|
+
"type": "array"
|
|
630
|
+
},
|
|
617
631
|
"repositories": {
|
|
618
632
|
"default": [],
|
|
619
633
|
"items": {
|
|
@@ -635,6 +649,7 @@
|
|
|
635
649
|
"compute",
|
|
636
650
|
"hooks",
|
|
637
651
|
"image",
|
|
652
|
+
"mcp_servers",
|
|
638
653
|
"repositories",
|
|
639
654
|
"variables"
|
|
640
655
|
],
|
|
@@ -824,9 +839,38 @@
|
|
|
824
839
|
"title": "AgentConfigInput",
|
|
825
840
|
"type": "object"
|
|
826
841
|
},
|
|
842
|
+
"AgentConfigMcpRemoteServer": {
|
|
843
|
+
"additionalProperties": false,
|
|
844
|
+
"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.",
|
|
845
|
+
"properties": {
|
|
846
|
+
"headers": {
|
|
847
|
+
"additionalProperties": {
|
|
848
|
+
"type": "string"
|
|
849
|
+
},
|
|
850
|
+
"default": {},
|
|
851
|
+
"title": "Headers",
|
|
852
|
+
"type": "object"
|
|
853
|
+
},
|
|
854
|
+
"name": {
|
|
855
|
+
"title": "Name",
|
|
856
|
+
"type": "string"
|
|
857
|
+
},
|
|
858
|
+
"url": {
|
|
859
|
+
"title": "Url",
|
|
860
|
+
"type": "string"
|
|
861
|
+
}
|
|
862
|
+
},
|
|
863
|
+
"required": [
|
|
864
|
+
"headers",
|
|
865
|
+
"name",
|
|
866
|
+
"url"
|
|
867
|
+
],
|
|
868
|
+
"title": "AgentConfigMcpRemoteServer",
|
|
869
|
+
"type": "object"
|
|
870
|
+
},
|
|
827
871
|
"AgentConfigMcpServer": {
|
|
828
872
|
"additionalProperties": false,
|
|
829
|
-
"description": "One built-in MCP server this agent opts into by name (`linear`/`slack`).\
|
|
873
|
+
"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`).",
|
|
830
874
|
"properties": {
|
|
831
875
|
"name": {
|
|
832
876
|
"title": "Name",
|
|
@@ -839,6 +883,44 @@
|
|
|
839
883
|
"title": "AgentConfigMcpServer",
|
|
840
884
|
"type": "object"
|
|
841
885
|
},
|
|
886
|
+
"AgentConfigMcpStdioServer": {
|
|
887
|
+
"additionalProperties": false,
|
|
888
|
+
"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.",
|
|
889
|
+
"properties": {
|
|
890
|
+
"args": {
|
|
891
|
+
"default": [],
|
|
892
|
+
"items": {
|
|
893
|
+
"type": "string"
|
|
894
|
+
},
|
|
895
|
+
"title": "Args",
|
|
896
|
+
"type": "array"
|
|
897
|
+
},
|
|
898
|
+
"command": {
|
|
899
|
+
"title": "Command",
|
|
900
|
+
"type": "string"
|
|
901
|
+
},
|
|
902
|
+
"env": {
|
|
903
|
+
"additionalProperties": {
|
|
904
|
+
"type": "string"
|
|
905
|
+
},
|
|
906
|
+
"default": {},
|
|
907
|
+
"title": "Env",
|
|
908
|
+
"type": "object"
|
|
909
|
+
},
|
|
910
|
+
"name": {
|
|
911
|
+
"title": "Name",
|
|
912
|
+
"type": "string"
|
|
913
|
+
}
|
|
914
|
+
},
|
|
915
|
+
"required": [
|
|
916
|
+
"args",
|
|
917
|
+
"command",
|
|
918
|
+
"env",
|
|
919
|
+
"name"
|
|
920
|
+
],
|
|
921
|
+
"title": "AgentConfigMcpStdioServer",
|
|
922
|
+
"type": "object"
|
|
923
|
+
},
|
|
842
924
|
"AgentConfigMemorySize": {
|
|
843
925
|
"additionalProperties": false,
|
|
844
926
|
"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.",
|
|
@@ -878,10 +960,9 @@
|
|
|
878
960
|
"type": "object"
|
|
879
961
|
},
|
|
880
962
|
"AgentConfigMentionPlatform": {
|
|
881
|
-
"description": "The surface an @ellipsis mention can come from.",
|
|
963
|
+
"description": "The surface an @ellipsis mention can come from.\n\nNo SLACK member: Slack routing is not a trigger on an agent config, it is the\n`slack.yaml` routing file (`SlackConfig`), which answers the questions a\nplatform list cannot \u2014 which channel, and whose DM. A mention trigger listing\n`slack` is therefore a config error, not a silently-never-fires config.",
|
|
882
964
|
"enum": [
|
|
883
965
|
"github",
|
|
884
|
-
"slack",
|
|
885
966
|
"linear"
|
|
886
967
|
],
|
|
887
968
|
"title": "AgentConfigMentionPlatform",
|
|
@@ -2526,6 +2607,18 @@
|
|
|
2526
2607
|
"title": "EllipsisGrant",
|
|
2527
2608
|
"type": "object"
|
|
2528
2609
|
},
|
|
2610
|
+
"EnvironmentSource": {
|
|
2611
|
+
"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.",
|
|
2612
|
+
"enum": [
|
|
2613
|
+
"request",
|
|
2614
|
+
"agent_config",
|
|
2615
|
+
"repo_default",
|
|
2616
|
+
"account_default",
|
|
2617
|
+
"platform_default"
|
|
2618
|
+
],
|
|
2619
|
+
"title": "EnvironmentSource",
|
|
2620
|
+
"type": "string"
|
|
2621
|
+
},
|
|
2529
2622
|
"ErrorFrame": {
|
|
2530
2623
|
"description": "Terminal error marker, sent before the server closes with code 1011.",
|
|
2531
2624
|
"properties": {
|
|
@@ -3191,6 +3284,7 @@
|
|
|
3191
3284
|
"reviews",
|
|
3192
3285
|
"configs",
|
|
3193
3286
|
"defaults",
|
|
3287
|
+
"environments",
|
|
3194
3288
|
"secrets",
|
|
3195
3289
|
"templates",
|
|
3196
3290
|
"integrations",
|
|
@@ -4024,6 +4118,10 @@
|
|
|
4024
4118
|
"title": "Created At",
|
|
4025
4119
|
"type": "string"
|
|
4026
4120
|
},
|
|
4121
|
+
"environment": {
|
|
4122
|
+
"$ref": "#/$defs/SessionEnvironment",
|
|
4123
|
+
"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."
|
|
4124
|
+
},
|
|
4027
4125
|
"exit_status": {
|
|
4028
4126
|
"anyOf": [
|
|
4029
4127
|
{
|
|
@@ -4194,6 +4292,7 @@
|
|
|
4194
4292
|
"context_repository",
|
|
4195
4293
|
"cost",
|
|
4196
4294
|
"created_at",
|
|
4295
|
+
"environment",
|
|
4197
4296
|
"exit_status",
|
|
4198
4297
|
"git",
|
|
4199
4298
|
"harness",
|
|
@@ -4380,6 +4479,42 @@
|
|
|
4380
4479
|
"title": "SessionCost",
|
|
4381
4480
|
"type": "object"
|
|
4382
4481
|
},
|
|
4482
|
+
"SessionEnvironment": {
|
|
4483
|
+
"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.",
|
|
4484
|
+
"properties": {
|
|
4485
|
+
"environment_id": {
|
|
4486
|
+
"anyOf": [
|
|
4487
|
+
{
|
|
4488
|
+
"type": "string"
|
|
4489
|
+
},
|
|
4490
|
+
{
|
|
4491
|
+
"type": "null"
|
|
4492
|
+
}
|
|
4493
|
+
],
|
|
4494
|
+
"default": null,
|
|
4495
|
+
"description": "Identifier of the saved environment the session's config resolved. Null for an inline environment block or the built-in basic sandbox.",
|
|
4496
|
+
"title": "Environment Id"
|
|
4497
|
+
},
|
|
4498
|
+
"source": {
|
|
4499
|
+
"anyOf": [
|
|
4500
|
+
{
|
|
4501
|
+
"$ref": "#/$defs/EnvironmentSource"
|
|
4502
|
+
},
|
|
4503
|
+
{
|
|
4504
|
+
"type": "null"
|
|
4505
|
+
}
|
|
4506
|
+
],
|
|
4507
|
+
"default": null,
|
|
4508
|
+
"description": "How the environment was chosen (request, agent_config, repo_default, account_default, platform_default). Null when the config carried its own inline environment."
|
|
4509
|
+
}
|
|
4510
|
+
},
|
|
4511
|
+
"required": [
|
|
4512
|
+
"environment_id",
|
|
4513
|
+
"source"
|
|
4514
|
+
],
|
|
4515
|
+
"title": "SessionEnvironment",
|
|
4516
|
+
"type": "object"
|
|
4517
|
+
},
|
|
4383
4518
|
"SessionExitStatus": {
|
|
4384
4519
|
"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.",
|
|
4385
4520
|
"enum": [
|