@agentmc/api 0.2.2 → 0.2.3

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.
@@ -4,8 +4,8 @@ Generated from `spec/openapi.filtered.json`.
4
4
 
5
5
  | Operation ID | Method | Path | Tags |
6
6
  | --- | --- | --- | --- |
7
- | [agentConnectedInstructions](./agentConnectedInstructions.md) | GET | `/agents/{agent}/instructions` | Agents |
8
7
  | [agentHeartbeat](./agentHeartbeat.md) | POST | `/agents/{agent}/heartbeat` | Agents |
8
+ | [agentInstructions](./agentInstructions.md) | GET | `/agents/{agent}/agent-instructions` | Agents |
9
9
  | [authenticateAgentRealtimeSocket](./authenticateAgentRealtimeSocket.md) | POST | `/agents/{agent}/realtime/sessions/{session}/socket-auth` | Agents |
10
10
  | [claimAgentRealtimeSession](./claimAgentRealtimeSession.md) | POST | `/agents/{agent}/realtime/sessions/{session}/claim` | Agents |
11
11
  | [closeAgentRealtimeSession](./closeAgentRealtimeSession.md) | POST | `/agents/{agent}/realtime/sessions/{session}/close` | Agents |
@@ -1,8 +1,8 @@
1
- # agentConnectedInstructions
1
+ # agentInstructions
2
2
 
3
3
  - Method: `GET`
4
- - Path: `/agents/{agent}/instructions`
5
- - Summary: Return runtime instructions for a connected agent using bearer auth.
4
+ - Path: `/agents/{agent}/agent-instructions`
5
+ - Summary: Return agent instructions for a connected agent using bearer auth.
6
6
  - Auth: AgentBearerAuth
7
7
 
8
8
  ## Description
@@ -22,11 +22,12 @@ None.
22
22
  ## Success Responses
23
23
 
24
24
  ### 200 (application/json)
25
- Instructions returned.
25
+ Agent instructions returned.
26
26
 
27
27
  ```json
28
28
  {
29
- "instructions": "# AgentMC Agent Sync Skill",
29
+ "agent_instructions": "# Agent Instructions",
30
+ "agent_instructions_version": "32fe7fd14fca2d57c545f5f78f4a1c094f9ac1b3a1e8f6f9f8323b67a0ef9cc3",
30
31
  "docs": [],
31
32
  "schedules": [],
32
33
  "config": {}
@@ -103,7 +104,7 @@ const client = new AgentMCApi({
103
104
  agentToken: process.env.AGENTMC_AGENT_TOKEN
104
105
  });
105
106
 
106
- const result = await client.operations.agentConnectedInstructions({
107
+ const result = await client.operations.agentInstructions({
107
108
  "params": {
108
109
  "path": {
109
110
  "agent": 1
@@ -121,7 +122,7 @@ if (result.error) {
121
122
  ## cURL Example
122
123
 
123
124
  ```bash
124
- curl -X GET "https://agentmc.ai/api/v1/agents/1/instructions" \\
125
+ curl -X GET "https://agentmc.ai/api/v1/agents/1/agent-instructions" \\
125
126
  -H "Accept: application/json" \\
126
127
  -H "Authorization: Bearer $AGENTMC_AGENT_TOKEN"
127
128
  ```
@@ -79,8 +79,8 @@ Agent connected and bearer token issued.
79
79
  {
80
80
  "agent_id": 42,
81
81
  "agent_token": "mca_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
82
- "agent_instructions_endpoint": "https://agentmc.example.com/api/v1/agents/42/instructions",
83
- "agent_authenticated_instructions_endpoint": "https://agentmc.example.com/api/v1/agents/42/instructions",
82
+ "agent_instructions_endpoint": "https://agentmc.example.com/api/v1/agents/42/agent-instructions",
83
+ "agent_authenticated_instructions_endpoint": "https://agentmc.example.com/api/v1/agents/42/agent-instructions",
84
84
  "agent_instructions_version": "32fe7fd14fca2d57c545f5f78f4a1c094f9ac1b3a1e8f6f9f8323b67a0ef9cc3",
85
85
  "openapi_url": "https://agentmc.example.com/api/openapi.json",
86
86
  "workspace": {
@@ -1,101 +1,4 @@
1
1
  [
2
- {
3
- "operationId": "agentConnectedInstructions",
4
- "method": "get",
5
- "path": "/agents/{agent}/instructions",
6
- "summary": "Return runtime instructions for a connected agent using bearer auth.",
7
- "description": "",
8
- "tags": [
9
- "Agents"
10
- ],
11
- "security": [
12
- [
13
- "AgentBearerAuth"
14
- ]
15
- ],
16
- "parameters": [
17
- {
18
- "name": "agent",
19
- "in": "path",
20
- "required": true,
21
- "description": "Agent identifier.",
22
- "example": 1
23
- }
24
- ],
25
- "requestBodyRequired": false,
26
- "requestExamples": [],
27
- "responses": [
28
- {
29
- "status": "200",
30
- "mediaType": "application/json",
31
- "description": "Instructions returned.",
32
- "hasContent": true,
33
- "example": {
34
- "instructions": "# AgentMC Agent Sync Skill",
35
- "docs": [],
36
- "schedules": [],
37
- "config": {}
38
- }
39
- },
40
- {
41
- "status": "401",
42
- "mediaType": "application/json",
43
- "description": "Missing or invalid credentials.",
44
- "hasContent": true,
45
- "example": {
46
- "error": {
47
- "code": "validation.failed",
48
- "message": "Validation failed.",
49
- "details": {
50
- "fields": {
51
- "title": [
52
- "The title field is required."
53
- ]
54
- }
55
- }
56
- }
57
- }
58
- },
59
- {
60
- "status": "403",
61
- "mediaType": "application/json",
62
- "description": "Forbidden.",
63
- "hasContent": true,
64
- "example": {
65
- "error": {
66
- "code": "validation.failed",
67
- "message": "Validation failed.",
68
- "details": {
69
- "fields": {
70
- "title": [
71
- "The title field is required."
72
- ]
73
- }
74
- }
75
- }
76
- }
77
- },
78
- {
79
- "status": "404",
80
- "mediaType": "application/json",
81
- "description": "Resource not found.",
82
- "hasContent": true,
83
- "example": {
84
- "error": {
85
- "code": "validation.failed",
86
- "message": "Validation failed.",
87
- "details": {
88
- "fields": {
89
- "title": [
90
- "The title field is required."
91
- ]
92
- }
93
- }
94
- }
95
- }
96
- }
97
- ]
98
- },
99
2
  {
100
3
  "operationId": "agentHeartbeat",
101
4
  "method": "post",
@@ -302,6 +205,104 @@
302
205
  }
303
206
  ]
304
207
  },
208
+ {
209
+ "operationId": "agentInstructions",
210
+ "method": "get",
211
+ "path": "/agents/{agent}/agent-instructions",
212
+ "summary": "Return agent instructions for a connected agent using bearer auth.",
213
+ "description": "",
214
+ "tags": [
215
+ "Agents"
216
+ ],
217
+ "security": [
218
+ [
219
+ "AgentBearerAuth"
220
+ ]
221
+ ],
222
+ "parameters": [
223
+ {
224
+ "name": "agent",
225
+ "in": "path",
226
+ "required": true,
227
+ "description": "Agent identifier.",
228
+ "example": 1
229
+ }
230
+ ],
231
+ "requestBodyRequired": false,
232
+ "requestExamples": [],
233
+ "responses": [
234
+ {
235
+ "status": "200",
236
+ "mediaType": "application/json",
237
+ "description": "Agent instructions returned.",
238
+ "hasContent": true,
239
+ "example": {
240
+ "agent_instructions": "# Agent Instructions",
241
+ "agent_instructions_version": "32fe7fd14fca2d57c545f5f78f4a1c094f9ac1b3a1e8f6f9f8323b67a0ef9cc3",
242
+ "docs": [],
243
+ "schedules": [],
244
+ "config": {}
245
+ }
246
+ },
247
+ {
248
+ "status": "401",
249
+ "mediaType": "application/json",
250
+ "description": "Missing or invalid credentials.",
251
+ "hasContent": true,
252
+ "example": {
253
+ "error": {
254
+ "code": "validation.failed",
255
+ "message": "Validation failed.",
256
+ "details": {
257
+ "fields": {
258
+ "title": [
259
+ "The title field is required."
260
+ ]
261
+ }
262
+ }
263
+ }
264
+ }
265
+ },
266
+ {
267
+ "status": "403",
268
+ "mediaType": "application/json",
269
+ "description": "Forbidden.",
270
+ "hasContent": true,
271
+ "example": {
272
+ "error": {
273
+ "code": "validation.failed",
274
+ "message": "Validation failed.",
275
+ "details": {
276
+ "fields": {
277
+ "title": [
278
+ "The title field is required."
279
+ ]
280
+ }
281
+ }
282
+ }
283
+ }
284
+ },
285
+ {
286
+ "status": "404",
287
+ "mediaType": "application/json",
288
+ "description": "Resource not found.",
289
+ "hasContent": true,
290
+ "example": {
291
+ "error": {
292
+ "code": "validation.failed",
293
+ "message": "Validation failed.",
294
+ "details": {
295
+ "fields": {
296
+ "title": [
297
+ "The title field is required."
298
+ ]
299
+ }
300
+ }
301
+ }
302
+ }
303
+ }
304
+ ]
305
+ },
305
306
  {
306
307
  "operationId": "authenticateAgentRealtimeSocket",
307
308
  "method": "post",
@@ -992,8 +993,8 @@
992
993
  "example": {
993
994
  "agent_id": 42,
994
995
  "agent_token": "mca_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
995
- "agent_instructions_endpoint": "https://agentmc.example.com/api/v1/agents/42/instructions",
996
- "agent_authenticated_instructions_endpoint": "https://agentmc.example.com/api/v1/agents/42/instructions",
996
+ "agent_instructions_endpoint": "https://agentmc.example.com/api/v1/agents/42/agent-instructions",
997
+ "agent_authenticated_instructions_endpoint": "https://agentmc.example.com/api/v1/agents/42/agent-instructions",
997
998
  "agent_instructions_version": "32fe7fd14fca2d57c545f5f78f4a1c094f9ac1b3a1e8f6f9f8323b67a0ef9cc3",
998
999
  "openapi_url": "https://agentmc.example.com/api/openapi.json",
999
1000
  "workspace": {
@@ -4,7 +4,7 @@ const client = new AgentMCApi({
4
4
  agentToken: process.env.AGENTMC_AGENT_TOKEN
5
5
  });
6
6
 
7
- const result = await client.operations.agentConnectedInstructions({
7
+ const result = await client.operations.agentInstructions({
8
8
  "params": {
9
9
  "path": {
10
10
  "agent": 1
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@agentmc/api",
3
- "version": "0.2.2",
3
+ "version": "0.2.3",
4
4
  "description": "AgentMC API SDK, docs, and CLI for AI agents",
5
5
  "type": "module",
6
6
  "license": "MIT",
@@ -45,7 +45,8 @@
45
45
  "prepack": "npm run build",
46
46
  "changeset": "changeset",
47
47
  "version-packages": "changeset version",
48
- "release": "changeset publish"
48
+ "release": "changeset publish",
49
+ "release:full": "npm run changeset && npm run version-packages && npm run release"
49
50
  },
50
51
  "dependencies": {
51
52
  "commander": "^14.0.1",
@@ -30,8 +30,8 @@
30
30
  "example": {
31
31
  "agent_id": 42,
32
32
  "agent_token": "mca_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
33
- "agent_instructions_endpoint": "https://agentmc.example.com/api/v1/agents/42/instructions",
34
- "agent_authenticated_instructions_endpoint": "https://agentmc.example.com/api/v1/agents/42/instructions",
33
+ "agent_instructions_endpoint": "https://agentmc.example.com/api/v1/agents/42/agent-instructions",
34
+ "agent_authenticated_instructions_endpoint": "https://agentmc.example.com/api/v1/agents/42/agent-instructions",
35
35
  "agent_instructions_version": "32fe7fd14fca2d57c545f5f78f4a1c094f9ac1b3a1e8f6f9f8323b67a0ef9cc3",
36
36
  "openapi_url": "https://agentmc.example.com/api/openapi.json",
37
37
  "workspace": {
@@ -65,13 +65,13 @@
65
65
  }
66
66
  }
67
67
  },
68
- "/agents/{agent}/instructions": {
68
+ "/agents/{agent}/agent-instructions": {
69
69
  "get": {
70
70
  "tags": [
71
71
  "Agents"
72
72
  ],
73
- "summary": "Return runtime instructions for a connected agent using bearer auth.",
74
- "operationId": "agentConnectedInstructions",
73
+ "summary": "Return agent instructions for a connected agent using bearer auth.",
74
+ "operationId": "agentInstructions",
75
75
  "parameters": [
76
76
  {
77
77
  "name": "agent",
@@ -87,14 +87,15 @@
87
87
  ],
88
88
  "responses": {
89
89
  "200": {
90
- "description": "Instructions returned.",
90
+ "description": "Agent instructions returned.",
91
91
  "content": {
92
92
  "application/json": {
93
93
  "schema": {
94
- "$ref": "#/components/schemas/ConnectedAgentInstructionsResponse"
94
+ "$ref": "#/components/schemas/AgentInstructionsResponse"
95
95
  },
96
96
  "example": {
97
- "instructions": "# AgentMC Agent Sync Skill",
97
+ "agent_instructions": "# Agent Instructions",
98
+ "agent_instructions_version": "32fe7fd14fca2d57c545f5f78f4a1c094f9ac1b3a1e8f6f9f8323b67a0ef9cc3",
98
99
  "docs": [],
99
100
  "schedules": [],
100
101
  "config": {}
@@ -5172,13 +5173,13 @@
5172
5173
  "agent_instructions_endpoint": {
5173
5174
  "type": "string",
5174
5175
  "format": "uri",
5175
- "description": "Endpoint for agent runtime instructions.",
5176
+ "description": "Endpoint for agent instructions updates.",
5176
5177
  "example": "https://agentmc.example.com/resource"
5177
5178
  },
5178
5179
  "agent_authenticated_instructions_endpoint": {
5179
5180
  "type": "string",
5180
5181
  "format": "uri",
5181
- "description": "Authenticated endpoint for agent runtime instructions.",
5182
+ "description": "Authenticated endpoint for agent instructions updates.",
5182
5183
  "example": "https://agentmc.example.com/resource"
5183
5184
  },
5184
5185
  "agent_instructions_version": {
@@ -5217,12 +5218,12 @@
5217
5218
  "example": true
5218
5219
  }
5219
5220
  },
5220
- "description": "Connect/registration response with agent credentials, authenticated instructions endpoint, and OpenAPI URL.",
5221
+ "description": "Connect/registration response with agent credentials, authenticated agent instructions endpoint, and OpenAPI URL.",
5221
5222
  "example": {
5222
5223
  "agent_id": 42,
5223
5224
  "agent_token": "mca_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
5224
- "agent_instructions_endpoint": "https://agentmc.example.com/api/v1/agents/42/instructions",
5225
- "agent_authenticated_instructions_endpoint": "https://agentmc.example.com/api/v1/agents/42/instructions",
5225
+ "agent_instructions_endpoint": "https://agentmc.example.com/api/v1/agents/42/agent-instructions",
5226
+ "agent_authenticated_instructions_endpoint": "https://agentmc.example.com/api/v1/agents/42/agent-instructions",
5226
5227
  "agent_instructions_version": "32fe7fd14fca2d57c545f5f78f4a1c094f9ac1b3a1e8f6f9f8323b67a0ef9cc3",
5227
5228
  "openapi_url": "https://agentmc.example.com/api/openapi.json",
5228
5229
  "workspace": {
@@ -5234,18 +5235,24 @@
5234
5235
  "first_sync_required": true
5235
5236
  }
5236
5237
  },
5237
- "ConnectedAgentInstructionsResponse": {
5238
+ "AgentInstructionsResponse": {
5238
5239
  "type": "object",
5239
5240
  "required": [
5240
- "instructions",
5241
+ "agent_instructions",
5242
+ "agent_instructions_version",
5241
5243
  "docs",
5242
5244
  "schedules",
5243
5245
  "config"
5244
5246
  ],
5245
5247
  "properties": {
5246
- "instructions": {
5248
+ "agent_instructions": {
5247
5249
  "type": "string",
5248
- "description": "Instructions.",
5250
+ "description": "Agent instructions.",
5251
+ "example": "example"
5252
+ },
5253
+ "agent_instructions_version": {
5254
+ "type": "string",
5255
+ "description": "Agent instructions version.",
5249
5256
  "example": "example"
5250
5257
  },
5251
5258
  "docs": {
@@ -5283,9 +5290,10 @@
5283
5290
  }
5284
5291
  }
5285
5292
  },
5286
- "description": "Connected agent instruction payload returned after successful bearer authentication.",
5293
+ "description": "Connected agent instructions payload returned after successful bearer authentication.",
5287
5294
  "example": {
5288
- "instructions": "# AgentMC Agent Sync Skill",
5295
+ "agent_instructions": "# Agent Instructions",
5296
+ "agent_instructions_version": "32fe7fd14fca2d57c545f5f78f4a1c094f9ac1b3a1e8f6f9f8323b67a0ef9cc3",
5289
5297
  "docs": [],
5290
5298
  "schedules": [],
5291
5299
  "config": {}
@@ -12259,8 +12267,8 @@
12259
12267
  "example": {
12260
12268
  "agent_id": 42,
12261
12269
  "agent_token": "mca_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
12262
- "agent_instructions_endpoint": "https://agentmc.example.com/api/v1/agents/42/instructions",
12263
- "agent_authenticated_instructions_endpoint": "https://agentmc.example.com/api/v1/agents/42/instructions",
12270
+ "agent_instructions_endpoint": "https://agentmc.example.com/api/v1/agents/42/agent-instructions",
12271
+ "agent_authenticated_instructions_endpoint": "https://agentmc.example.com/api/v1/agents/42/agent-instructions",
12264
12272
  "agent_instructions_version": "32fe7fd14fca2d57c545f5f78f4a1c094f9ac1b3a1e8f6f9f8323b67a0ef9cc3",
12265
12273
  "openapi_url": "https://agentmc.example.com/api/openapi.json",
12266
12274
  "workspace": {
@@ -12274,15 +12282,16 @@
12274
12282
  }
12275
12283
  }
12276
12284
  },
12277
- "ConnectedAgentInstructionsResponse": {
12285
+ "AgentInstructionsResponse": {
12278
12286
  "description": "Agent instructions returned.",
12279
12287
  "content": {
12280
12288
  "application/json": {
12281
12289
  "schema": {
12282
- "$ref": "#/components/schemas/ConnectedAgentInstructionsResponse"
12290
+ "$ref": "#/components/schemas/AgentInstructionsResponse"
12283
12291
  },
12284
12292
  "example": {
12285
- "instructions": "# AgentMC Agent Sync Skill",
12293
+ "agent_instructions": "# Agent Instructions",
12294
+ "agent_instructions_version": "32fe7fd14fca2d57c545f5f78f4a1c094f9ac1b3a1e8f6f9f8323b67a0ef9cc3",
12286
12295
  "docs": [],
12287
12296
  "schedules": [],
12288
12297
  "config": {}