@octavus/docs 2.11.0 → 2.13.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.
Files changed (33) hide show
  1. package/content/02-server-sdk/02-sessions.md +1 -0
  2. package/content/02-server-sdk/05-cli.md +9 -3
  3. package/content/03-client-sdk/01-overview.md +17 -0
  4. package/content/03-client-sdk/06-http-transport.md +1 -0
  5. package/content/03-client-sdk/08-file-uploads.md +57 -3
  6. package/content/03-client-sdk/09-error-handling.md +28 -4
  7. package/content/04-protocol/01-overview.md +12 -6
  8. package/content/04-protocol/04-tools.md +4 -3
  9. package/content/04-protocol/07-agent-config.md +46 -1
  10. package/content/04-protocol/08-provider-options.md +2 -7
  11. package/content/04-protocol/11-workers.md +4 -2
  12. package/content/04-protocol/12-references.md +189 -0
  13. package/content/05-api-reference/02-sessions.md +6 -5
  14. package/content/05-api-reference/03-agents.md +31 -9
  15. package/dist/{chunk-H6M6M3MY.js → chunk-PYLADDXH.js} +51 -31
  16. package/dist/chunk-PYLADDXH.js.map +1 -0
  17. package/dist/{chunk-NCTX3Y2J.js → chunk-SNBEHHFU.js} +43 -25
  18. package/dist/chunk-SNBEHHFU.js.map +1 -0
  19. package/dist/{chunk-EIUCL4CP.js → chunk-Z5E72EIS.js} +51 -31
  20. package/dist/chunk-Z5E72EIS.js.map +1 -0
  21. package/dist/content.js +1 -1
  22. package/dist/docs.json +25 -16
  23. package/dist/index.js +1 -1
  24. package/dist/search-index.json +1 -1
  25. package/dist/search.js +1 -1
  26. package/dist/search.js.map +1 -1
  27. package/dist/sections.json +25 -16
  28. package/package.json +1 -1
  29. package/dist/chunk-6TO62UOU.js +0 -1489
  30. package/dist/chunk-6TO62UOU.js.map +0 -1
  31. package/dist/chunk-EIUCL4CP.js.map +0 -1
  32. package/dist/chunk-H6M6M3MY.js.map +0 -1
  33. package/dist/chunk-NCTX3Y2J.js.map +0 -1
package/content/05-api-reference/03-agents.md CHANGED
@@ -5,7 +5,7 @@ description: Agent management API endpoints.
5
5
 
6
6
  # Agents API
7
7
 
8
- Manage agent definitions including protocols and prompts.
8
+ Manage agent definitions including protocols, prompts, and references.
9
9
 
10
10
  ## Permissions
11
11
 
@@ -82,6 +82,13 @@ GET /api/agents/:id
82
82
  "name": "user-message",
83
83
  "content": "{{USER_MESSAGE}}"
84
84
  }
85
+ ],
86
+ "references": [
87
+ {
88
+ "name": "api-guidelines",
89
+ "description": "API design guidelines and conventions",
90
+ "content": "# API Guidelines\n\nUse lowercase with dashes..."
91
+ }
85
92
  ]
86
93
  }
87
94
  ```
@@ -119,18 +126,26 @@ POST /api/agents
119
126
  "name": "system",
120
127
  "content": "You are a support agent..."
121
128
  }
129
+ ],
130
+ "references": [
131
+ {
132
+ "name": "api-guidelines",
133
+ "description": "API design guidelines and conventions",
134
+ "content": "# API Guidelines\n..."
135
+ }
122
136
  ]
123
137
  }
124
138
  ```
125
139
 
126
- | Field | Type | Required | Description |
127
- | ---------------------- | ------ | -------- | ------------------------- |
128
- | `settings.slug` | string | Yes | URL-safe identifier |
129
- | `settings.name` | string | Yes | Display name |
130
- | `settings.description` | string | No | Agent description |
131
- | `settings.format` | string | Yes | `interactive` or `worker` |
132
- | `protocol` | string | Yes | YAML protocol definition |
133
- | `prompts` | array | Yes | Prompt files |
140
+ | Field | Type | Required | Description |
141
+ | ---------------------- | ------ | -------- | ------------------------------------------------ |
142
+ | `settings.slug` | string | Yes | URL-safe identifier |
143
+ | `settings.name` | string | Yes | Display name |
144
+ | `settings.description` | string | No | Agent description |
145
+ | `settings.format` | string | Yes | `interactive` or `worker` |
146
+ | `protocol` | string | Yes | YAML protocol definition |
147
+ | `prompts` | array | Yes | Prompt files |
148
+ | `references` | array | No | Reference documents (name, description, content) |
134
149
 
135
150
  ### Response
136
151
 
@@ -178,6 +193,13 @@ PATCH /api/agents/:id
178
193
  "name": "system",
179
194
  "content": "Updated system prompt..."
180
195
  }
196
+ ],
197
+ "references": [
198
+ {
199
+ "name": "api-guidelines",
200
+ "description": "Updated description",
201
+ "content": "Updated content..."
202
+ }
181
203
  ]
182
204
  }
183
205
  ```