@topline-build/harness-mcp 0.6.0 → 0.8.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/CHANGELOG.md +18 -0
- package/README.md +14 -0
- package/dist/domain-tools.d.ts +11 -0
- package/dist/domain-tools.js +53 -0
- package/dist/index.d.ts +26 -4
- package/dist/index.js +300 -31
- package/docs/generated/build-mcp-manifest.json +926 -17
- package/docs/generated/build-mcp-reference.md +863 -12
- package/package.json +2 -1
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> Generated from `src/index.ts#BUILD_MCP_TOOLS`. Do not edit this file by hand.
|
|
4
4
|
|
|
5
|
-
Package: `@topline-build/harness-mcp@0.
|
|
5
|
+
Package: `@topline-build/harness-mcp@0.8.0`
|
|
6
6
|
Transport: `stdio`
|
|
7
7
|
Default protocol: `2025-11-25`
|
|
8
8
|
Canonical guide: https://topline.build/docs/build-mcp-guide
|
|
@@ -21,10 +21,10 @@ The first authenticated tool call normally opens browser approval. Set `TOPLINE_
|
|
|
21
21
|
| --- | --- | --- | --- |
|
|
22
22
|
| `--url` | `TOPLINE_API_URL`, `PLATFORM_API_URL`, `OVERSITE_API_URL` | required | Topline tenant base URL. HTTPS is required except for loopback development. |
|
|
23
23
|
| `--workspace-root` | `TOPLINE_WORKSPACE_ROOT`, `PLATFORM_WORKSPACE_ROOT` | `current working directory` | Local root that contains artifact app directories. |
|
|
24
|
-
| `--surface` | `TOPLINE_MCP_SURFACE` | `build` |
|
|
24
|
+
| `--surface` | `TOPLINE_MCP_SURFACE` | `build` | topline is one server for Build and Workspace tools; build serves Build tools only; harness preserves legacy OAuth compatibility. |
|
|
25
25
|
| `--protocol-version` | `TOPLINE_MCP_PROTOCOL_VERSION`, `PLATFORM_MCP_PROTOCOL_VERSION` | `2025-11-25` | MCP protocol version sent to Topline HTTP endpoints. |
|
|
26
26
|
| `--auth-file` | `TOPLINE_MCP_AUTH_FILE`, `PLATFORM_MCP_AUTH_FILE` | `per-tenant file in the local Topline config directory` | OAuth credential cache. Keep it outside artifact app directories. |
|
|
27
|
-
| `--scopes` | `TOPLINE_MCP_SCOPES`, `PLATFORM_MCP_SCOPES` | `
|
|
27
|
+
| `--scopes` | `TOPLINE_MCP_SCOPES`, `PLATFORM_MCP_SCOPES` | `Build scopes; every Topline scope with --surface topline` | Space- or comma-separated OAuth scopes. |
|
|
28
28
|
| `--timeout-ms` | `TOPLINE_MCP_TIMEOUT_MS`, `PLATFORM_MCP_TIMEOUT_MS`, `OVERSITE_MCP_TIMEOUT_MS` | `120000` | Positive request timeout in milliseconds. |
|
|
29
29
|
| `--token` | `TOPLINE_MCP_TOKEN`, `PLATFORM_MCP_TOKEN`, `OVERSITE_MCP_TOKEN` | `optional` | Advanced manual bearer-token fallback. Prefer browser-approved OAuth. |
|
|
30
30
|
|
|
@@ -32,7 +32,39 @@ The first authenticated tool call normally opens browser approval. Set `TOPLINE_
|
|
|
32
32
|
|
|
33
33
|
Tool failures set `isError: true` and return `structuredContent.error` with `code`, `message`, `retryable`, and `recoveryAction`.
|
|
34
34
|
|
|
35
|
+
- `capability_unavailable` (not automatically retryable): Read current domain/address state and the original receipt with the saved pre-call key. Retain the exact original input. Review changed state, scopes or configuration before any new plan/key; never assume a rejected delivery means no effect.
|
|
36
|
+
- `domain_manage_required` (not automatically retryable): Read current domain/address state and the original receipt with the saved pre-call key. Retain the exact original input. Review changed state, scopes or configuration before any new plan/key; never assume a rejected delivery means no effect.
|
|
37
|
+
- `artifact_not_found` (not automatically retryable): Read current domain/address state and the original receipt with the saved pre-call key. Retain the exact original input. Review changed state, scopes or configuration before any new plan/key; never assume a rejected delivery means no effect.
|
|
38
|
+
- `artifact_app_required` (not automatically retryable): Read current domain/address state and the original receipt with the saved pre-call key. Retain the exact original input. Review changed state, scopes or configuration before any new plan/key; never assume a rejected delivery means no effect.
|
|
39
|
+
- `domain_not_found` (not automatically retryable): Read current domain/address state and the original receipt with the saved pre-call key. Retain the exact original input. Review changed state, scopes or configuration before any new plan/key; never assume a rejected delivery means no effect.
|
|
40
|
+
- `domain_not_connected` (not automatically retryable): Read current domain/address state and the original receipt with the saved pre-call key. Retain the exact original input. Review changed state, scopes or configuration before any new plan/key; never assume a rejected delivery means no effect.
|
|
41
|
+
- `operation_not_found` (not automatically retryable): Read current domain/address state and the original receipt with the saved pre-call key. Retain the exact original input. Review changed state, scopes or configuration before any new plan/key; never assume a rejected delivery means no effect.
|
|
42
|
+
- `hostname_required` (not automatically retryable): Read current domain/address state and the original receipt with the saved pre-call key. Retain the exact original input. Review changed state, scopes or configuration before any new plan/key; never assume a rejected delivery means no effect.
|
|
43
|
+
- `hostname_invalid` (not automatically retryable): Read current domain/address state and the original receipt with the saved pre-call key. Retain the exact original input. Review changed state, scopes or configuration before any new plan/key; never assume a rejected delivery means no effect.
|
|
44
|
+
- `subdomain_required` (not automatically retryable): Read current domain/address state and the original receipt with the saved pre-call key. Retain the exact original input. Review changed state, scopes or configuration before any new plan/key; never assume a rejected delivery means no effect.
|
|
45
|
+
- `topline_domain_not_customer_domain` (not automatically retryable): Read current domain/address state and the original receipt with the saved pre-call key. Retain the exact original input. Review changed state, scopes or configuration before any new plan/key; never assume a rejected delivery means no effect.
|
|
46
|
+
- `path_required` (not automatically retryable): Read current domain/address state and the original receipt with the saved pre-call key. Retain the exact original input. Review changed state, scopes or configuration before any new plan/key; never assume a rejected delivery means no effect.
|
|
47
|
+
- `path_invalid` (not automatically retryable): Read current domain/address state and the original receipt with the saved pre-call key. Retain the exact original input. Review changed state, scopes or configuration before any new plan/key; never assume a rejected delivery means no effect.
|
|
48
|
+
- `path_reserved` (not automatically retryable): Read current domain/address state and the original receipt with the saved pre-call key. Retain the exact original input. Review changed state, scopes or configuration before any new plan/key; never assume a rejected delivery means no effect.
|
|
49
|
+
- `zone_invalid` (not automatically retryable): Read current domain/address state and the original receipt with the saved pre-call key. Retain the exact original input. Review changed state, scopes or configuration before any new plan/key; never assume a rejected delivery means no effect.
|
|
50
|
+
- `domain_path_in_use` (not automatically retryable): Read current domain/address state and the original receipt with the saved pre-call key. Retain the exact original input. Review changed state, scopes or configuration before any new plan/key; never assume a rejected delivery means no effect.
|
|
51
|
+
- `domain_already_claimed` (not automatically retryable): Read current domain/address state and the original receipt with the saved pre-call key. Retain the exact original input. Review changed state, scopes or configuration before any new plan/key; never assume a rejected delivery means no effect.
|
|
52
|
+
- `address_state_changed` (not automatically retryable): Read current domain/address state and the original receipt with the saved pre-call key. Retain the exact original input. Review changed state, scopes or configuration before any new plan/key; never assume a rejected delivery means no effect.
|
|
53
|
+
- `domain_state_changed` (not automatically retryable): Read current domain/address state and the original receipt with the saved pre-call key. Retain the exact original input. Review changed state, scopes or configuration before any new plan/key; never assume a rejected delivery means no effect.
|
|
54
|
+
- `plan_expired` (not automatically retryable): Read current domain/address state and the original receipt with the saved pre-call key. Retain the exact original input. Review changed state, scopes or configuration before any new plan/key; never assume a rejected delivery means no effect.
|
|
55
|
+
- `plan_already_used` (not automatically retryable): Read current domain/address state and the original receipt with the saved pre-call key. Retain the exact original input. Review changed state, scopes or configuration before any new plan/key; never assume a rejected delivery means no effect.
|
|
56
|
+
- `verification_interrupted` (not automatically retryable): Read current domain/address state and the original receipt with the saved pre-call key. Retain the exact original input. Review changed state, scopes or configuration before any new plan/key; never assume a rejected delivery means no effect.
|
|
57
|
+
- `verification_pending` (not automatically retryable): Read current domain/address state and the original receipt with the saved pre-call key. Retain the exact original input. Review changed state, scopes or configuration before any new plan/key; never assume a rejected delivery means no effect.
|
|
58
|
+
- `verification_rate_limited` (not automatically retryable): Read current domain/address state and the original receipt with the saved pre-call key. Retain the exact original input. Review changed state, scopes or configuration before any new plan/key; never assume a rejected delivery means no effect.
|
|
59
|
+
- `waiting_for_dns` (not automatically retryable): Read current domain/address state and the original receipt with the saved pre-call key. Retain the exact original input. Review changed state, scopes or configuration before any new plan/key; never assume a rejected delivery means no effect.
|
|
60
|
+
- `idempotency_conflict` (not automatically retryable): Read current domain/address state and the original receipt with the saved pre-call key. Retain the exact original input. Review changed state, scopes or configuration before any new plan/key; never assume a rejected delivery means no effect.
|
|
61
|
+
- `domain_setup_limit` (not automatically retryable): Read current domain/address state and the original receipt with the saved pre-call key. Retain the exact original input. Review changed state, scopes or configuration before any new plan/key; never assume a rejected delivery means no effect.
|
|
62
|
+
- `domain_operation_failed` (not automatically retryable): Read current domain/address state and the original receipt with the saved pre-call key. Retain the exact original input. Review changed state, scopes or configuration before any new plan/key; never assume a rejected delivery means no effect.
|
|
63
|
+
- `invalid_arguments` (not automatically retryable): Read current domain/address state and the original receipt with the saved pre-call key. Retain the exact original input. Review changed state, scopes or configuration before any new plan/key; never assume a rejected delivery means no effect.
|
|
35
64
|
- `authorization_required` (not automatically retryable): Clear only this connection's cached OAuth credentials, then reconnect the Build MCP through browser sign-in. If using a manual bearer token, replace the expired or revoked token. Recover existing artifact/deployment progress before retrying a write.
|
|
65
|
+
- `scope_required` (not automatically retryable): Reconnect the Build MCP and approve the requested scope.
|
|
66
|
+
- `domain_tools_require_build_oauth` (not automatically retryable): Read current domain/address state and the original receipt with the saved pre-call key. Retain the exact original input. Review changed state, scopes or configuration before any new plan/key; never assume a rejected delivery means no effect.
|
|
67
|
+
- `domain_result_unknown` (not automatically retryable): The response did not establish an outcome. Recover the original receipt through platform_get_artifact_address (saved artifactId and apply key) or platform_read_artifact_domains (request/verify kind and key). Preserve the original plan/domain/input/key; an absent, pending or expired receipt does not authorize a fresh key. No mutation is replayed automatically.
|
|
36
68
|
- `platform_harness_timeout` (retryable): Retry the call. For a deployment, use platform_list_artifact_drafts to recover the artifact and platform_wait_artifact_deploy to resume progress.
|
|
37
69
|
- `platform_mcp_tool_error` (not automatically retryable): Read the returned error code, correct the request or OAuth scopes, then retry.
|
|
38
70
|
- `artifact_deploy_wait_timeout` (retryable): Call platform_wait_artifact_deploy again with the same artifactId and operationId.
|
|
@@ -42,23 +74,20 @@ Tool failures set `isError: true` and return `structuredContent.error` with `cod
|
|
|
42
74
|
- `artifact_app_auth_file_inside_app_dir` (not automatically retryable): Move TOPLINE_MCP_AUTH_FILE outside appDir, reconnect the Build MCP, then inspect again.
|
|
43
75
|
- `artifact_app_manifest_not_found` (not automatically retryable): Create artifact-app.json inside appDir, or correct appDir, then inspect again.
|
|
44
76
|
- `artifact_app_manifest_too_large` (not automatically retryable): Keep artifact-app.json below 512 KiB. Move application data and source into separate files, then inspect again.
|
|
45
|
-
- `scope_required` (not automatically retryable): Reconnect the Build MCP and approve the requested scope.
|
|
46
77
|
- `artifact_app_scaffold_target_not_empty` (not automatically retryable): Choose an empty appDir or deploy the existing app without scaffolding.
|
|
47
78
|
|
|
48
79
|
## Tools
|
|
49
80
|
|
|
50
81
|
### `platform_connection_check`
|
|
51
82
|
|
|
52
|
-
|
|
83
|
+
Tell Topline Developer Access that this signed-in client works. Run it with no arguments right after signing in. Pass verificationCode only when Developer Access shows one for a manual check.
|
|
53
84
|
|
|
54
85
|
Safety: read-only=false, destructive=false, idempotent=false, open-world=true.
|
|
55
86
|
|
|
56
87
|
Example request:
|
|
57
88
|
|
|
58
89
|
```json
|
|
59
|
-
{
|
|
60
|
-
"verificationCode": "example-verification-code"
|
|
61
|
-
}
|
|
90
|
+
{}
|
|
62
91
|
```
|
|
63
92
|
|
|
64
93
|
Example success:
|
|
@@ -84,9 +113,6 @@ Input schema:
|
|
|
84
113
|
"maxLength": 80
|
|
85
114
|
}
|
|
86
115
|
},
|
|
87
|
-
"required": [
|
|
88
|
-
"verificationCode"
|
|
89
|
-
],
|
|
90
116
|
"additionalProperties": false
|
|
91
117
|
}
|
|
92
118
|
```
|
|
@@ -109,7 +135,8 @@ Output schema:
|
|
|
109
135
|
"product": {
|
|
110
136
|
"type": "string",
|
|
111
137
|
"enum": [
|
|
112
|
-
"build"
|
|
138
|
+
"build",
|
|
139
|
+
"topline"
|
|
113
140
|
]
|
|
114
141
|
},
|
|
115
142
|
"verifiedAt": {
|
|
@@ -4613,3 +4640,827 @@ Output schema:
|
|
|
4613
4640
|
]
|
|
4614
4641
|
}
|
|
4615
4642
|
```
|
|
4643
|
+
|
|
4644
|
+
### `platform_read_artifact_domains`
|
|
4645
|
+
|
|
4646
|
+
Read connected company domains. With domainId, an explicitly scoped manager can read DNS/TLS setup state. With recovery, recover an original request/verify receipt by operation ID or its pre-call key; reads never retry setup or write DNS. Manager detail/recovery requires the setup capability.
|
|
4647
|
+
|
|
4648
|
+
Safety: read-only=true, destructive=false, idempotent=true, open-world=false.
|
|
4649
|
+
|
|
4650
|
+
Example request:
|
|
4651
|
+
|
|
4652
|
+
```json
|
|
4653
|
+
{}
|
|
4654
|
+
```
|
|
4655
|
+
|
|
4656
|
+
Example success:
|
|
4657
|
+
|
|
4658
|
+
```json
|
|
4659
|
+
{}
|
|
4660
|
+
```
|
|
4661
|
+
|
|
4662
|
+
Input schema:
|
|
4663
|
+
|
|
4664
|
+
```json
|
|
4665
|
+
{
|
|
4666
|
+
"type": "object",
|
|
4667
|
+
"additionalProperties": false,
|
|
4668
|
+
"properties": {
|
|
4669
|
+
"limit": {
|
|
4670
|
+
"type": "integer",
|
|
4671
|
+
"minimum": 1,
|
|
4672
|
+
"maximum": 100
|
|
4673
|
+
},
|
|
4674
|
+
"cursor": {
|
|
4675
|
+
"type": "integer",
|
|
4676
|
+
"minimum": 0,
|
|
4677
|
+
"maximum": 10000
|
|
4678
|
+
},
|
|
4679
|
+
"includePending": {
|
|
4680
|
+
"type": "boolean"
|
|
4681
|
+
},
|
|
4682
|
+
"domainId": {
|
|
4683
|
+
"type": "string",
|
|
4684
|
+
"format": "uuid"
|
|
4685
|
+
},
|
|
4686
|
+
"zoneName": {
|
|
4687
|
+
"type": "string",
|
|
4688
|
+
"minLength": 1,
|
|
4689
|
+
"maxLength": 253
|
|
4690
|
+
},
|
|
4691
|
+
"recovery": {
|
|
4692
|
+
"oneOf": [
|
|
4693
|
+
{
|
|
4694
|
+
"type": "object",
|
|
4695
|
+
"additionalProperties": false,
|
|
4696
|
+
"properties": {
|
|
4697
|
+
"operationId": {
|
|
4698
|
+
"type": "string",
|
|
4699
|
+
"format": "uuid"
|
|
4700
|
+
}
|
|
4701
|
+
},
|
|
4702
|
+
"required": [
|
|
4703
|
+
"operationId"
|
|
4704
|
+
]
|
|
4705
|
+
},
|
|
4706
|
+
{
|
|
4707
|
+
"type": "object",
|
|
4708
|
+
"additionalProperties": false,
|
|
4709
|
+
"properties": {
|
|
4710
|
+
"kind": {
|
|
4711
|
+
"enum": [
|
|
4712
|
+
"request",
|
|
4713
|
+
"verify"
|
|
4714
|
+
]
|
|
4715
|
+
},
|
|
4716
|
+
"idempotencyKey": {
|
|
4717
|
+
"type": "string",
|
|
4718
|
+
"minLength": 1,
|
|
4719
|
+
"maxLength": 128,
|
|
4720
|
+
"pattern": "^[\\x21-\\x7E]+$"
|
|
4721
|
+
}
|
|
4722
|
+
},
|
|
4723
|
+
"required": [
|
|
4724
|
+
"kind",
|
|
4725
|
+
"idempotencyKey"
|
|
4726
|
+
]
|
|
4727
|
+
}
|
|
4728
|
+
]
|
|
4729
|
+
}
|
|
4730
|
+
},
|
|
4731
|
+
"required": [],
|
|
4732
|
+
"oneOf": [
|
|
4733
|
+
{
|
|
4734
|
+
"not": {
|
|
4735
|
+
"anyOf": [
|
|
4736
|
+
{
|
|
4737
|
+
"required": [
|
|
4738
|
+
"domainId"
|
|
4739
|
+
]
|
|
4740
|
+
},
|
|
4741
|
+
{
|
|
4742
|
+
"required": [
|
|
4743
|
+
"recovery"
|
|
4744
|
+
]
|
|
4745
|
+
},
|
|
4746
|
+
{
|
|
4747
|
+
"required": [
|
|
4748
|
+
"zoneName"
|
|
4749
|
+
]
|
|
4750
|
+
}
|
|
4751
|
+
]
|
|
4752
|
+
}
|
|
4753
|
+
},
|
|
4754
|
+
{
|
|
4755
|
+
"required": [
|
|
4756
|
+
"domainId"
|
|
4757
|
+
],
|
|
4758
|
+
"not": {
|
|
4759
|
+
"anyOf": [
|
|
4760
|
+
{
|
|
4761
|
+
"required": [
|
|
4762
|
+
"limit"
|
|
4763
|
+
]
|
|
4764
|
+
},
|
|
4765
|
+
{
|
|
4766
|
+
"required": [
|
|
4767
|
+
"cursor"
|
|
4768
|
+
]
|
|
4769
|
+
},
|
|
4770
|
+
{
|
|
4771
|
+
"required": [
|
|
4772
|
+
"includePending"
|
|
4773
|
+
]
|
|
4774
|
+
},
|
|
4775
|
+
{
|
|
4776
|
+
"required": [
|
|
4777
|
+
"recovery"
|
|
4778
|
+
]
|
|
4779
|
+
}
|
|
4780
|
+
]
|
|
4781
|
+
}
|
|
4782
|
+
},
|
|
4783
|
+
{
|
|
4784
|
+
"required": [
|
|
4785
|
+
"recovery"
|
|
4786
|
+
],
|
|
4787
|
+
"not": {
|
|
4788
|
+
"anyOf": [
|
|
4789
|
+
{
|
|
4790
|
+
"required": [
|
|
4791
|
+
"domainId"
|
|
4792
|
+
]
|
|
4793
|
+
},
|
|
4794
|
+
{
|
|
4795
|
+
"required": [
|
|
4796
|
+
"zoneName"
|
|
4797
|
+
]
|
|
4798
|
+
},
|
|
4799
|
+
{
|
|
4800
|
+
"required": [
|
|
4801
|
+
"cursor"
|
|
4802
|
+
]
|
|
4803
|
+
},
|
|
4804
|
+
{
|
|
4805
|
+
"required": [
|
|
4806
|
+
"limit"
|
|
4807
|
+
]
|
|
4808
|
+
},
|
|
4809
|
+
{
|
|
4810
|
+
"required": [
|
|
4811
|
+
"includePending"
|
|
4812
|
+
]
|
|
4813
|
+
}
|
|
4814
|
+
]
|
|
4815
|
+
}
|
|
4816
|
+
}
|
|
4817
|
+
]
|
|
4818
|
+
}
|
|
4819
|
+
```
|
|
4820
|
+
|
|
4821
|
+
Output schema:
|
|
4822
|
+
|
|
4823
|
+
```json
|
|
4824
|
+
{
|
|
4825
|
+
"type": "object",
|
|
4826
|
+
"oneOf": [
|
|
4827
|
+
{
|
|
4828
|
+
"type": "object",
|
|
4829
|
+
"properties": {
|
|
4830
|
+
"ok": {
|
|
4831
|
+
"const": true
|
|
4832
|
+
}
|
|
4833
|
+
}
|
|
4834
|
+
},
|
|
4835
|
+
{
|
|
4836
|
+
"type": "object",
|
|
4837
|
+
"properties": {
|
|
4838
|
+
"ok": {
|
|
4839
|
+
"const": false
|
|
4840
|
+
},
|
|
4841
|
+
"error": {
|
|
4842
|
+
"type": "object",
|
|
4843
|
+
"properties": {
|
|
4844
|
+
"code": {
|
|
4845
|
+
"type": "string"
|
|
4846
|
+
},
|
|
4847
|
+
"message": {
|
|
4848
|
+
"type": "string"
|
|
4849
|
+
},
|
|
4850
|
+
"retryable": {
|
|
4851
|
+
"type": "boolean"
|
|
4852
|
+
},
|
|
4853
|
+
"recoveryAction": {
|
|
4854
|
+
"type": "string"
|
|
4855
|
+
},
|
|
4856
|
+
"recovery": {
|
|
4857
|
+
"type": "object",
|
|
4858
|
+
"additionalProperties": true
|
|
4859
|
+
}
|
|
4860
|
+
},
|
|
4861
|
+
"required": [
|
|
4862
|
+
"code",
|
|
4863
|
+
"message",
|
|
4864
|
+
"retryable",
|
|
4865
|
+
"recoveryAction"
|
|
4866
|
+
],
|
|
4867
|
+
"additionalProperties": false
|
|
4868
|
+
}
|
|
4869
|
+
},
|
|
4870
|
+
"required": [
|
|
4871
|
+
"ok",
|
|
4872
|
+
"error"
|
|
4873
|
+
],
|
|
4874
|
+
"additionalProperties": false
|
|
4875
|
+
}
|
|
4876
|
+
]
|
|
4877
|
+
}
|
|
4878
|
+
```
|
|
4879
|
+
|
|
4880
|
+
### `platform_get_artifact_address`
|
|
4881
|
+
|
|
4882
|
+
Read an owned hosted app's exact company address, revision, connection and publication state. Optional recovery returns the original address-apply receipt under its current write scopes; it does not reapply. Saving an address never publishes an app or changes audience.
|
|
4883
|
+
|
|
4884
|
+
Safety: read-only=true, destructive=false, idempotent=true, open-world=false.
|
|
4885
|
+
|
|
4886
|
+
Example request:
|
|
4887
|
+
|
|
4888
|
+
```json
|
|
4889
|
+
{
|
|
4890
|
+
"artifactId": "00000000-0000-4000-8000-000000000001"
|
|
4891
|
+
}
|
|
4892
|
+
```
|
|
4893
|
+
|
|
4894
|
+
Example success:
|
|
4895
|
+
|
|
4896
|
+
```json
|
|
4897
|
+
{}
|
|
4898
|
+
```
|
|
4899
|
+
|
|
4900
|
+
Input schema:
|
|
4901
|
+
|
|
4902
|
+
```json
|
|
4903
|
+
{
|
|
4904
|
+
"type": "object",
|
|
4905
|
+
"additionalProperties": false,
|
|
4906
|
+
"properties": {
|
|
4907
|
+
"artifactId": {
|
|
4908
|
+
"type": "string",
|
|
4909
|
+
"format": "uuid"
|
|
4910
|
+
},
|
|
4911
|
+
"recovery": {
|
|
4912
|
+
"oneOf": [
|
|
4913
|
+
{
|
|
4914
|
+
"type": "object",
|
|
4915
|
+
"additionalProperties": false,
|
|
4916
|
+
"properties": {
|
|
4917
|
+
"operationId": {
|
|
4918
|
+
"type": "string",
|
|
4919
|
+
"format": "uuid"
|
|
4920
|
+
}
|
|
4921
|
+
},
|
|
4922
|
+
"required": [
|
|
4923
|
+
"operationId"
|
|
4924
|
+
]
|
|
4925
|
+
},
|
|
4926
|
+
{
|
|
4927
|
+
"type": "object",
|
|
4928
|
+
"additionalProperties": false,
|
|
4929
|
+
"properties": {
|
|
4930
|
+
"idempotencyKey": {
|
|
4931
|
+
"type": "string",
|
|
4932
|
+
"minLength": 1,
|
|
4933
|
+
"maxLength": 128,
|
|
4934
|
+
"pattern": "^[\\x21-\\x7E]+$"
|
|
4935
|
+
}
|
|
4936
|
+
},
|
|
4937
|
+
"required": [
|
|
4938
|
+
"idempotencyKey"
|
|
4939
|
+
]
|
|
4940
|
+
}
|
|
4941
|
+
]
|
|
4942
|
+
}
|
|
4943
|
+
},
|
|
4944
|
+
"required": [
|
|
4945
|
+
"artifactId"
|
|
4946
|
+
]
|
|
4947
|
+
}
|
|
4948
|
+
```
|
|
4949
|
+
|
|
4950
|
+
Output schema:
|
|
4951
|
+
|
|
4952
|
+
```json
|
|
4953
|
+
{
|
|
4954
|
+
"type": "object",
|
|
4955
|
+
"oneOf": [
|
|
4956
|
+
{
|
|
4957
|
+
"type": "object",
|
|
4958
|
+
"properties": {
|
|
4959
|
+
"ok": {
|
|
4960
|
+
"const": true
|
|
4961
|
+
}
|
|
4962
|
+
}
|
|
4963
|
+
},
|
|
4964
|
+
{
|
|
4965
|
+
"type": "object",
|
|
4966
|
+
"properties": {
|
|
4967
|
+
"ok": {
|
|
4968
|
+
"const": false
|
|
4969
|
+
},
|
|
4970
|
+
"error": {
|
|
4971
|
+
"type": "object",
|
|
4972
|
+
"properties": {
|
|
4973
|
+
"code": {
|
|
4974
|
+
"type": "string"
|
|
4975
|
+
},
|
|
4976
|
+
"message": {
|
|
4977
|
+
"type": "string"
|
|
4978
|
+
},
|
|
4979
|
+
"retryable": {
|
|
4980
|
+
"type": "boolean"
|
|
4981
|
+
},
|
|
4982
|
+
"recoveryAction": {
|
|
4983
|
+
"type": "string"
|
|
4984
|
+
},
|
|
4985
|
+
"recovery": {
|
|
4986
|
+
"type": "object",
|
|
4987
|
+
"additionalProperties": true
|
|
4988
|
+
}
|
|
4989
|
+
},
|
|
4990
|
+
"required": [
|
|
4991
|
+
"code",
|
|
4992
|
+
"message",
|
|
4993
|
+
"retryable",
|
|
4994
|
+
"recoveryAction"
|
|
4995
|
+
],
|
|
4996
|
+
"additionalProperties": false
|
|
4997
|
+
}
|
|
4998
|
+
},
|
|
4999
|
+
"required": [
|
|
5000
|
+
"ok",
|
|
5001
|
+
"error"
|
|
5002
|
+
],
|
|
5003
|
+
"additionalProperties": false
|
|
5004
|
+
}
|
|
5005
|
+
]
|
|
5006
|
+
}
|
|
5007
|
+
```
|
|
5008
|
+
|
|
5009
|
+
### `platform_plan_artifact_address`
|
|
5010
|
+
|
|
5011
|
+
Store a ten-minute single-use address preview for the owned app. domainId=null explicitly detaches the company route. Show old/new URLs and readiness before applying; this changes no customer address or DNS.
|
|
5012
|
+
|
|
5013
|
+
Safety: read-only=false, destructive=false, idempotent=false, open-world=false.
|
|
5014
|
+
|
|
5015
|
+
Example request:
|
|
5016
|
+
|
|
5017
|
+
```json
|
|
5018
|
+
{
|
|
5019
|
+
"artifactId": "00000000-0000-4000-8000-000000000001",
|
|
5020
|
+
"domainId": "00000000-0000-4000-8000-000000000001",
|
|
5021
|
+
"path": "<path>"
|
|
5022
|
+
}
|
|
5023
|
+
```
|
|
5024
|
+
|
|
5025
|
+
Example success:
|
|
5026
|
+
|
|
5027
|
+
```json
|
|
5028
|
+
{}
|
|
5029
|
+
```
|
|
5030
|
+
|
|
5031
|
+
Input schema:
|
|
5032
|
+
|
|
5033
|
+
```json
|
|
5034
|
+
{
|
|
5035
|
+
"type": "object",
|
|
5036
|
+
"additionalProperties": false,
|
|
5037
|
+
"properties": {
|
|
5038
|
+
"artifactId": {
|
|
5039
|
+
"type": "string",
|
|
5040
|
+
"format": "uuid"
|
|
5041
|
+
},
|
|
5042
|
+
"domainId": {
|
|
5043
|
+
"type": [
|
|
5044
|
+
"string",
|
|
5045
|
+
"null"
|
|
5046
|
+
],
|
|
5047
|
+
"format": "uuid"
|
|
5048
|
+
},
|
|
5049
|
+
"path": {
|
|
5050
|
+
"type": "string",
|
|
5051
|
+
"minLength": 1,
|
|
5052
|
+
"maxLength": 70
|
|
5053
|
+
}
|
|
5054
|
+
},
|
|
5055
|
+
"required": [
|
|
5056
|
+
"artifactId",
|
|
5057
|
+
"domainId"
|
|
5058
|
+
],
|
|
5059
|
+
"oneOf": [
|
|
5060
|
+
{
|
|
5061
|
+
"properties": {
|
|
5062
|
+
"domainId": {
|
|
5063
|
+
"type": "string",
|
|
5064
|
+
"format": "uuid"
|
|
5065
|
+
}
|
|
5066
|
+
},
|
|
5067
|
+
"required": [
|
|
5068
|
+
"path"
|
|
5069
|
+
]
|
|
5070
|
+
},
|
|
5071
|
+
{
|
|
5072
|
+
"properties": {
|
|
5073
|
+
"domainId": {
|
|
5074
|
+
"type": "null"
|
|
5075
|
+
}
|
|
5076
|
+
},
|
|
5077
|
+
"not": {
|
|
5078
|
+
"required": [
|
|
5079
|
+
"path"
|
|
5080
|
+
]
|
|
5081
|
+
}
|
|
5082
|
+
}
|
|
5083
|
+
]
|
|
5084
|
+
}
|
|
5085
|
+
```
|
|
5086
|
+
|
|
5087
|
+
Output schema:
|
|
5088
|
+
|
|
5089
|
+
```json
|
|
5090
|
+
{
|
|
5091
|
+
"type": "object",
|
|
5092
|
+
"oneOf": [
|
|
5093
|
+
{
|
|
5094
|
+
"type": "object",
|
|
5095
|
+
"properties": {
|
|
5096
|
+
"ok": {
|
|
5097
|
+
"const": true
|
|
5098
|
+
}
|
|
5099
|
+
}
|
|
5100
|
+
},
|
|
5101
|
+
{
|
|
5102
|
+
"type": "object",
|
|
5103
|
+
"properties": {
|
|
5104
|
+
"ok": {
|
|
5105
|
+
"const": false
|
|
5106
|
+
},
|
|
5107
|
+
"error": {
|
|
5108
|
+
"type": "object",
|
|
5109
|
+
"properties": {
|
|
5110
|
+
"code": {
|
|
5111
|
+
"type": "string"
|
|
5112
|
+
},
|
|
5113
|
+
"message": {
|
|
5114
|
+
"type": "string"
|
|
5115
|
+
},
|
|
5116
|
+
"retryable": {
|
|
5117
|
+
"type": "boolean"
|
|
5118
|
+
},
|
|
5119
|
+
"recoveryAction": {
|
|
5120
|
+
"type": "string"
|
|
5121
|
+
},
|
|
5122
|
+
"recovery": {
|
|
5123
|
+
"type": "object",
|
|
5124
|
+
"additionalProperties": true
|
|
5125
|
+
}
|
|
5126
|
+
},
|
|
5127
|
+
"required": [
|
|
5128
|
+
"code",
|
|
5129
|
+
"message",
|
|
5130
|
+
"retryable",
|
|
5131
|
+
"recoveryAction"
|
|
5132
|
+
],
|
|
5133
|
+
"additionalProperties": false
|
|
5134
|
+
}
|
|
5135
|
+
},
|
|
5136
|
+
"required": [
|
|
5137
|
+
"ok",
|
|
5138
|
+
"error"
|
|
5139
|
+
],
|
|
5140
|
+
"additionalProperties": false
|
|
5141
|
+
}
|
|
5142
|
+
]
|
|
5143
|
+
}
|
|
5144
|
+
```
|
|
5145
|
+
|
|
5146
|
+
### `platform_apply_artifact_address`
|
|
5147
|
+
|
|
5148
|
+
Apply the exact owned address plan with a stable pre-call key. Rechecks authority and address/domain revisions; consumes the plan once, including a no-op. Recover a lost response through the address-read tool before a new effect. No promotion, audience or DNS write.
|
|
5149
|
+
|
|
5150
|
+
Safety: read-only=false, destructive=true, idempotent=true, open-world=false.
|
|
5151
|
+
|
|
5152
|
+
Example request:
|
|
5153
|
+
|
|
5154
|
+
```json
|
|
5155
|
+
{
|
|
5156
|
+
"planId": "00000000-0000-4000-8000-000000000001",
|
|
5157
|
+
"idempotencyKey": "example-request"
|
|
5158
|
+
}
|
|
5159
|
+
```
|
|
5160
|
+
|
|
5161
|
+
Example success:
|
|
5162
|
+
|
|
5163
|
+
```json
|
|
5164
|
+
{}
|
|
5165
|
+
```
|
|
5166
|
+
|
|
5167
|
+
Input schema:
|
|
5168
|
+
|
|
5169
|
+
```json
|
|
5170
|
+
{
|
|
5171
|
+
"type": "object",
|
|
5172
|
+
"additionalProperties": false,
|
|
5173
|
+
"properties": {
|
|
5174
|
+
"planId": {
|
|
5175
|
+
"type": "string",
|
|
5176
|
+
"format": "uuid"
|
|
5177
|
+
},
|
|
5178
|
+
"idempotencyKey": {
|
|
5179
|
+
"type": "string",
|
|
5180
|
+
"minLength": 1,
|
|
5181
|
+
"maxLength": 128,
|
|
5182
|
+
"pattern": "^[\\x21-\\x7E]+$"
|
|
5183
|
+
}
|
|
5184
|
+
},
|
|
5185
|
+
"required": [
|
|
5186
|
+
"planId",
|
|
5187
|
+
"idempotencyKey"
|
|
5188
|
+
]
|
|
5189
|
+
}
|
|
5190
|
+
```
|
|
5191
|
+
|
|
5192
|
+
Output schema:
|
|
5193
|
+
|
|
5194
|
+
```json
|
|
5195
|
+
{
|
|
5196
|
+
"type": "object",
|
|
5197
|
+
"oneOf": [
|
|
5198
|
+
{
|
|
5199
|
+
"type": "object",
|
|
5200
|
+
"properties": {
|
|
5201
|
+
"ok": {
|
|
5202
|
+
"const": true
|
|
5203
|
+
}
|
|
5204
|
+
}
|
|
5205
|
+
},
|
|
5206
|
+
{
|
|
5207
|
+
"type": "object",
|
|
5208
|
+
"properties": {
|
|
5209
|
+
"ok": {
|
|
5210
|
+
"const": false
|
|
5211
|
+
},
|
|
5212
|
+
"error": {
|
|
5213
|
+
"type": "object",
|
|
5214
|
+
"properties": {
|
|
5215
|
+
"code": {
|
|
5216
|
+
"type": "string"
|
|
5217
|
+
},
|
|
5218
|
+
"message": {
|
|
5219
|
+
"type": "string"
|
|
5220
|
+
},
|
|
5221
|
+
"retryable": {
|
|
5222
|
+
"type": "boolean"
|
|
5223
|
+
},
|
|
5224
|
+
"recoveryAction": {
|
|
5225
|
+
"type": "string"
|
|
5226
|
+
},
|
|
5227
|
+
"recovery": {
|
|
5228
|
+
"type": "object",
|
|
5229
|
+
"additionalProperties": true
|
|
5230
|
+
}
|
|
5231
|
+
},
|
|
5232
|
+
"required": [
|
|
5233
|
+
"code",
|
|
5234
|
+
"message",
|
|
5235
|
+
"retryable",
|
|
5236
|
+
"recoveryAction"
|
|
5237
|
+
],
|
|
5238
|
+
"additionalProperties": false
|
|
5239
|
+
}
|
|
5240
|
+
},
|
|
5241
|
+
"required": [
|
|
5242
|
+
"ok",
|
|
5243
|
+
"error"
|
|
5244
|
+
],
|
|
5245
|
+
"additionalProperties": false
|
|
5246
|
+
}
|
|
5247
|
+
]
|
|
5248
|
+
}
|
|
5249
|
+
```
|
|
5250
|
+
|
|
5251
|
+
### `platform_request_artifact_domain`
|
|
5252
|
+
|
|
5253
|
+
Manager-only request for an owned company subdomain. Save the key before calling. Returns exact ownership/routing DNS records; never writes customer DNS. The existing reconciler may make the first connected domain the initial default. No artifact is reassigned.
|
|
5254
|
+
|
|
5255
|
+
Safety: read-only=false, destructive=false, idempotent=true, open-world=false.
|
|
5256
|
+
|
|
5257
|
+
Example request:
|
|
5258
|
+
|
|
5259
|
+
```json
|
|
5260
|
+
{
|
|
5261
|
+
"hostname": "<hostname>",
|
|
5262
|
+
"idempotencyKey": "example-request"
|
|
5263
|
+
}
|
|
5264
|
+
```
|
|
5265
|
+
|
|
5266
|
+
Example success:
|
|
5267
|
+
|
|
5268
|
+
```json
|
|
5269
|
+
{}
|
|
5270
|
+
```
|
|
5271
|
+
|
|
5272
|
+
Input schema:
|
|
5273
|
+
|
|
5274
|
+
```json
|
|
5275
|
+
{
|
|
5276
|
+
"type": "object",
|
|
5277
|
+
"additionalProperties": false,
|
|
5278
|
+
"properties": {
|
|
5279
|
+
"hostname": {
|
|
5280
|
+
"type": "string",
|
|
5281
|
+
"minLength": 1,
|
|
5282
|
+
"maxLength": 253
|
|
5283
|
+
},
|
|
5284
|
+
"idempotencyKey": {
|
|
5285
|
+
"type": "string",
|
|
5286
|
+
"minLength": 1,
|
|
5287
|
+
"maxLength": 128,
|
|
5288
|
+
"pattern": "^[\\x21-\\x7E]+$"
|
|
5289
|
+
}
|
|
5290
|
+
},
|
|
5291
|
+
"required": [
|
|
5292
|
+
"hostname",
|
|
5293
|
+
"idempotencyKey"
|
|
5294
|
+
]
|
|
5295
|
+
}
|
|
5296
|
+
```
|
|
5297
|
+
|
|
5298
|
+
Output schema:
|
|
5299
|
+
|
|
5300
|
+
```json
|
|
5301
|
+
{
|
|
5302
|
+
"type": "object",
|
|
5303
|
+
"oneOf": [
|
|
5304
|
+
{
|
|
5305
|
+
"type": "object",
|
|
5306
|
+
"properties": {
|
|
5307
|
+
"ok": {
|
|
5308
|
+
"const": true
|
|
5309
|
+
}
|
|
5310
|
+
}
|
|
5311
|
+
},
|
|
5312
|
+
{
|
|
5313
|
+
"type": "object",
|
|
5314
|
+
"properties": {
|
|
5315
|
+
"ok": {
|
|
5316
|
+
"const": false
|
|
5317
|
+
},
|
|
5318
|
+
"error": {
|
|
5319
|
+
"type": "object",
|
|
5320
|
+
"properties": {
|
|
5321
|
+
"code": {
|
|
5322
|
+
"type": "string"
|
|
5323
|
+
},
|
|
5324
|
+
"message": {
|
|
5325
|
+
"type": "string"
|
|
5326
|
+
},
|
|
5327
|
+
"retryable": {
|
|
5328
|
+
"type": "boolean"
|
|
5329
|
+
},
|
|
5330
|
+
"recoveryAction": {
|
|
5331
|
+
"type": "string"
|
|
5332
|
+
},
|
|
5333
|
+
"recovery": {
|
|
5334
|
+
"type": "object",
|
|
5335
|
+
"additionalProperties": true
|
|
5336
|
+
}
|
|
5337
|
+
},
|
|
5338
|
+
"required": [
|
|
5339
|
+
"code",
|
|
5340
|
+
"message",
|
|
5341
|
+
"retryable",
|
|
5342
|
+
"recoveryAction"
|
|
5343
|
+
],
|
|
5344
|
+
"additionalProperties": false
|
|
5345
|
+
}
|
|
5346
|
+
},
|
|
5347
|
+
"required": [
|
|
5348
|
+
"ok",
|
|
5349
|
+
"error"
|
|
5350
|
+
],
|
|
5351
|
+
"additionalProperties": false
|
|
5352
|
+
}
|
|
5353
|
+
]
|
|
5354
|
+
}
|
|
5355
|
+
```
|
|
5356
|
+
|
|
5357
|
+
### `platform_verify_artifact_domain`
|
|
5358
|
+
|
|
5359
|
+
Manager-only bounded ownership verification for the exact current domain generation and pre-call key. Matching DNS admits the existing TLS reconciler once. Same keys retain outcomes; use a new key only after a definite terminal no-admission outcome and covered retry intent. Read status through domain reads.
|
|
5360
|
+
|
|
5361
|
+
Safety: read-only=false, destructive=false, idempotent=true, open-world=true.
|
|
5362
|
+
|
|
5363
|
+
Example request:
|
|
5364
|
+
|
|
5365
|
+
```json
|
|
5366
|
+
{
|
|
5367
|
+
"domainId": "00000000-0000-4000-8000-000000000001",
|
|
5368
|
+
"expectedConnectionGeneration": 0,
|
|
5369
|
+
"idempotencyKey": "example-request"
|
|
5370
|
+
}
|
|
5371
|
+
```
|
|
5372
|
+
|
|
5373
|
+
Example success:
|
|
5374
|
+
|
|
5375
|
+
```json
|
|
5376
|
+
{}
|
|
5377
|
+
```
|
|
5378
|
+
|
|
5379
|
+
Input schema:
|
|
5380
|
+
|
|
5381
|
+
```json
|
|
5382
|
+
{
|
|
5383
|
+
"type": "object",
|
|
5384
|
+
"additionalProperties": false,
|
|
5385
|
+
"properties": {
|
|
5386
|
+
"domainId": {
|
|
5387
|
+
"type": "string",
|
|
5388
|
+
"format": "uuid"
|
|
5389
|
+
},
|
|
5390
|
+
"expectedConnectionGeneration": {
|
|
5391
|
+
"type": "integer",
|
|
5392
|
+
"minimum": 0
|
|
5393
|
+
},
|
|
5394
|
+
"idempotencyKey": {
|
|
5395
|
+
"type": "string",
|
|
5396
|
+
"minLength": 1,
|
|
5397
|
+
"maxLength": 128,
|
|
5398
|
+
"pattern": "^[\\x21-\\x7E]+$"
|
|
5399
|
+
}
|
|
5400
|
+
},
|
|
5401
|
+
"required": [
|
|
5402
|
+
"domainId",
|
|
5403
|
+
"expectedConnectionGeneration",
|
|
5404
|
+
"idempotencyKey"
|
|
5405
|
+
]
|
|
5406
|
+
}
|
|
5407
|
+
```
|
|
5408
|
+
|
|
5409
|
+
Output schema:
|
|
5410
|
+
|
|
5411
|
+
```json
|
|
5412
|
+
{
|
|
5413
|
+
"type": "object",
|
|
5414
|
+
"oneOf": [
|
|
5415
|
+
{
|
|
5416
|
+
"type": "object",
|
|
5417
|
+
"properties": {
|
|
5418
|
+
"ok": {
|
|
5419
|
+
"const": true
|
|
5420
|
+
}
|
|
5421
|
+
}
|
|
5422
|
+
},
|
|
5423
|
+
{
|
|
5424
|
+
"type": "object",
|
|
5425
|
+
"properties": {
|
|
5426
|
+
"ok": {
|
|
5427
|
+
"const": false
|
|
5428
|
+
},
|
|
5429
|
+
"error": {
|
|
5430
|
+
"type": "object",
|
|
5431
|
+
"properties": {
|
|
5432
|
+
"code": {
|
|
5433
|
+
"type": "string"
|
|
5434
|
+
},
|
|
5435
|
+
"message": {
|
|
5436
|
+
"type": "string"
|
|
5437
|
+
},
|
|
5438
|
+
"retryable": {
|
|
5439
|
+
"type": "boolean"
|
|
5440
|
+
},
|
|
5441
|
+
"recoveryAction": {
|
|
5442
|
+
"type": "string"
|
|
5443
|
+
},
|
|
5444
|
+
"recovery": {
|
|
5445
|
+
"type": "object",
|
|
5446
|
+
"additionalProperties": true
|
|
5447
|
+
}
|
|
5448
|
+
},
|
|
5449
|
+
"required": [
|
|
5450
|
+
"code",
|
|
5451
|
+
"message",
|
|
5452
|
+
"retryable",
|
|
5453
|
+
"recoveryAction"
|
|
5454
|
+
],
|
|
5455
|
+
"additionalProperties": false
|
|
5456
|
+
}
|
|
5457
|
+
},
|
|
5458
|
+
"required": [
|
|
5459
|
+
"ok",
|
|
5460
|
+
"error"
|
|
5461
|
+
],
|
|
5462
|
+
"additionalProperties": false
|
|
5463
|
+
}
|
|
5464
|
+
]
|
|
5465
|
+
}
|
|
5466
|
+
```
|