Skip to content

Commit 0c9905e

Browse files
hotlonghotlong
authored
Merge pull request #708 from objectstack-ai/copilot/fix-ci-errors
2 parents b7c472f + 7ee0196 commit 0c9905e

208 files changed

Lines changed: 8234 additions & 379 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎content/docs/references/ai/agent-action.mdx‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: Agent Action
33
description: Agent Action protocol schemas
44
---
55

6+
{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs go in content/docs/guides/. */}
7+
68
AI Agent Action Protocol
79

810
Defines how AI agents can interact with the UI by mapping natural language intents

‎content/docs/references/ai/agent.mdx‎

Lines changed: 56 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: Agent
33
description: Agent protocol schemas
44
---
55

6+
{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs go in content/docs/guides/. */}
7+
68
AI Model Configuration
79

810
<Callout type="info">
@@ -12,8 +14,8 @@ AI Model Configuration
1214
## TypeScript Usage
1315

1416
```typescript
15-
import { AIKnowledge, AIModelConfig, AITool, Agent } from '@objectstack/spec/ai';
16-
import type { AIKnowledge, AIModelConfig, AITool, Agent } from '@objectstack/spec/ai';
17+
import { AIKnowledge, AIModelConfig, AITool, Agent, StructuredOutputConfig, StructuredOutputFormat, TransformPipelineStep } from '@objectstack/spec/ai';
18+
import type { AIKnowledge, AIModelConfig, AITool, Agent, StructuredOutputConfig, StructuredOutputFormat, TransformPipelineStep } from '@objectstack/spec/ai';
1719

1820
// Validate data
1921
const result = AIKnowledge.parse(data);
@@ -80,6 +82,58 @@ const result = AIKnowledge.parse(data);
8082
| **access** | `string[]` | optional | Who can chat with this agent |
8183
| **tenantId** | `string` | optional | Tenant/Organization ID |
8284
| **visibility** | `Enum<'global' \| 'organization' \| 'private'>` | ✅ | |
85+
| **planning** | `Object` | optional | Autonomous reasoning and planning configuration |
86+
| **memory** | `Object` | optional | Agent memory management |
87+
| **guardrails** | `Object` | optional | Safety guardrails for the agent |
88+
| **structuredOutput** | `Object` | optional | Structured output format and validation configuration |
89+
90+
91+
---
92+
93+
## StructuredOutputConfig
94+
95+
Structured output configuration for agent responses
96+
97+
### Properties
98+
99+
| Property | Type | Required | Description |
100+
| :--- | :--- | :--- | :--- |
101+
| **format** | `Enum<'json_object' \| 'json_schema' \| 'regex' \| 'grammar' \| 'xml'>` | ✅ | Expected output format |
102+
| **schema** | `Record<string, any>` | optional | JSON Schema definition for output |
103+
| **strict** | `boolean` | ✅ | Enforce exact schema compliance |
104+
| **retryOnValidationFailure** | `boolean` | ✅ | Retry generation when output fails validation |
105+
| **maxRetries** | `integer` | ✅ | Maximum retries on validation failure |
106+
| **fallbackFormat** | `Enum<'json_object' \| 'json_schema' \| 'regex' \| 'grammar' \| 'xml'>` | optional | Fallback format if primary format fails |
107+
| **transformPipeline** | `Enum<'trim' \| 'parse_json' \| 'validate' \| 'coerce_types'>[]` | optional | Post-processing steps applied to output |
108+
109+
110+
---
111+
112+
## StructuredOutputFormat
113+
114+
Output format for structured agent responses
115+
116+
### Allowed Values
117+
118+
* `json_object`
119+
* `json_schema`
120+
* `regex`
121+
* `grammar`
122+
* `xml`
123+
124+
125+
---
126+
127+
## TransformPipelineStep
128+
129+
Post-processing step for structured output
130+
131+
### Allowed Values
132+
133+
* `trim`
134+
* `parse_json`
135+
* `validate`
136+
* `coerce_types`
83137

84138

85139
---

‎content/docs/references/ai/conversation.mdx‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: Conversation
33
description: Conversation protocol schemas
44
---
55

6+
{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs go in content/docs/guides/. */}
7+
68
AI Conversation Memory Protocol
79

810
Multi-turn AI conversations with token budget management.

‎content/docs/references/ai/cost.mdx‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: Cost
33
description: Cost protocol schemas
44
---
55

6+
{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs go in content/docs/guides/. */}
7+
68
AI Cost Tracking Protocol
79

810
Monitor and control AI API costs with budgets, alerts, and analytics.

‎content/docs/references/ai/devops-agent.mdx‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: Devops Agent
33
description: Devops Agent protocol schemas
44
---
55

6+
{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs go in content/docs/guides/. */}
7+
68
DevOps Agent Protocol
79

810
Defines autonomous DevOps agents that can self-iterate on enterprise
@@ -197,6 +199,10 @@ Code generation target
197199
| **access** | `string[]` | optional | Who can chat with this agent |
198200
| **tenantId** | `string` | optional | Tenant/Organization ID |
199201
| **visibility** | `Enum<'global' \| 'organization' \| 'private'>` | ✅ | |
202+
| **planning** | `Object` | optional | Autonomous reasoning and planning configuration |
203+
| **memory** | `Object` | optional | Agent memory management |
204+
| **guardrails** | `Object` | optional | Safety guardrails for the agent |
205+
| **structuredOutput** | `Object` | optional | Structured output format and validation configuration |
200206
| **developmentConfig** | `Object` | ✅ | Development configuration |
201207
| **pipelines** | `Object[]` | optional | CI/CD pipelines |
202208
| **versionManagement** | `Object` | optional | Version management configuration |

‎content/docs/references/ai/feedback-loop.mdx‎

Lines changed: 4 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,17 @@ title: Feedback Loop
33
description: Feedback Loop protocol schemas
44
---
55

6+
{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs go in content/docs/guides/. */}
7+
68
<Callout type="info">
79
**Source:** `packages/spec/src/ai/feedback-loop.zod.ts`
810
</Callout>
911

1012
## TypeScript Usage
1113

1214
```typescript
13-
import { FeedbackLoop, Issue, MetadataSource, Resolution } from '@objectstack/spec/ai';
14-
import type { FeedbackLoop, Issue, MetadataSource, Resolution } from '@objectstack/spec/ai';
15+
import { FeedbackLoop, Issue, Resolution } from '@objectstack/spec/ai';
16+
import type { FeedbackLoop, Issue, Resolution } from '@objectstack/spec/ai';
1517

1618
// Validate data
1719
const result = FeedbackLoop.parse(data);
@@ -49,23 +51,6 @@ const result = FeedbackLoop.parse(data);
4951
| **source** | `Object` | optional | |
5052

5153

52-
---
53-
54-
## MetadataSource
55-
56-
### Properties
57-
58-
| Property | Type | Required | Description |
59-
| :--- | :--- | :--- | :--- |
60-
| **file** | `string` | optional | |
61-
| **line** | `number` | optional | |
62-
| **column** | `number` | optional | |
63-
| **package** | `string` | optional | |
64-
| **object** | `string` | optional | |
65-
| **field** | `string` | optional | |
66-
| **component** | `string` | optional | |
67-
68-
6954
---
7055

7156
## Resolution

‎content/docs/references/ai/mcp.mdx‎

Lines changed: 88 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: Mcp
33
description: Mcp protocol schemas
44
---
55

6+
{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs go in content/docs/guides/. */}
7+
68
Model Context Protocol (MCP)
79

810
Defines the protocol for connecting AI assistants to external tools, data sources,
@@ -38,8 +40,8 @@ Use Cases:
3840
## TypeScript Usage
3941

4042
```typescript
41-
import { MCPCapability, MCPClientConfig, MCPPrompt, MCPPromptArgument, MCPPromptMessage, MCPPromptRequest, MCPPromptResponse, MCPResource, MCPResourceRequest, MCPResourceResponse, MCPResourceTemplate, MCPResourceType, MCPServerConfig, MCPServerInfo, MCPTool, MCPToolCallRequest, MCPToolCallResponse, MCPToolParameter, MCPTransportConfig, MCPTransportType } from '@objectstack/spec/ai';
42-
import type { MCPCapability, MCPClientConfig, MCPPrompt, MCPPromptArgument, MCPPromptMessage, MCPPromptRequest, MCPPromptResponse, MCPResource, MCPResourceRequest, MCPResourceResponse, MCPResourceTemplate, MCPResourceType, MCPServerConfig, MCPServerInfo, MCPTool, MCPToolCallRequest, MCPToolCallResponse, MCPToolParameter, MCPTransportConfig, MCPTransportType } from '@objectstack/spec/ai';
43+
import { MCPCapability, MCPClientConfig, MCPPrompt, MCPPromptArgument, MCPPromptMessage, MCPPromptRequest, MCPPromptResponse, MCPResource, MCPResourceRequest, MCPResourceResponse, MCPResourceTemplate, MCPResourceType, MCPRootEntry, MCPRootsConfig, MCPSamplingConfig, MCPServerConfig, MCPServerInfo, MCPStreamingConfig, MCPTool, MCPToolApproval, MCPToolCallRequest, MCPToolCallResponse, MCPToolParameter, MCPTransportConfig, MCPTransportType } from '@objectstack/spec/ai';
44+
import type { MCPCapability, MCPClientConfig, MCPPrompt, MCPPromptArgument, MCPPromptMessage, MCPPromptRequest, MCPPromptResponse, MCPResource, MCPResourceRequest, MCPResourceResponse, MCPResourceTemplate, MCPResourceType, MCPRootEntry, MCPRootsConfig, MCPSamplingConfig, MCPServerConfig, MCPServerInfo, MCPStreamingConfig, MCPTool, MCPToolApproval, MCPToolCallRequest, MCPToolCallResponse, MCPToolParameter, MCPTransportConfig, MCPTransportType } from '@objectstack/spec/ai';
4345

4446
// Validate data
4547
const result = MCPCapability.parse(data);
@@ -77,6 +79,7 @@ const result = MCPCapability.parse(data);
7779
| **retryDelay** | `integer` | ✅ | |
7880
| **enableLogging** | `boolean` | ✅ | |
7981
| **logLevel** | `Enum<'debug' \| 'info' \| 'warn' \| 'error'>` | ✅ | |
82+
| **roots** | `Object` | optional | Root directories/resources configuration |
8083

8184

8285
---
@@ -223,6 +226,54 @@ const result = MCPCapability.parse(data);
223226
* `stream`
224227

225228

229+
---
230+
231+
## MCPRootEntry
232+
233+
A single root directory or resource
234+
235+
### Properties
236+
237+
| Property | Type | Required | Description |
238+
| :--- | :--- | :--- | :--- |
239+
| **uri** | `string` | ✅ | Root URI (e.g., file:///path/to/project) |
240+
| **name** | `string` | optional | Human-readable root name |
241+
| **readOnly** | `boolean` | optional | Whether the root is read-only |
242+
243+
244+
---
245+
246+
## MCPRootsConfig
247+
248+
Roots configuration for MCP client
249+
250+
### Properties
251+
252+
| Property | Type | Required | Description |
253+
| :--- | :--- | :--- | :--- |
254+
| **roots** | `Object[]` | ✅ | Root directories or resources available to the client |
255+
| **watchForChanges** | `boolean` | ✅ | Watch root directories for filesystem changes |
256+
| **notifyOnChange** | `boolean` | ✅ | Notify server when root contents change |
257+
258+
259+
---
260+
261+
## MCPSamplingConfig
262+
263+
Sampling configuration for MCP
264+
265+
### Properties
266+
267+
| Property | Type | Required | Description |
268+
| :--- | :--- | :--- | :--- |
269+
| **enabled** | `boolean` | ✅ | Enable LLM sampling |
270+
| **maxTokens** | `integer` | ✅ | Maximum tokens to generate |
271+
| **temperature** | `number` | optional | Sampling temperature |
272+
| **stopSequences** | `string[]` | optional | Stop sequences to end generation |
273+
| **modelPreferences** | `string[]` | optional | Preferred model IDs in priority order |
274+
| **systemPrompt** | `string` | optional | System prompt for sampling context |
275+
276+
226277
---
227278

228279
## MCPServerConfig
@@ -250,6 +301,9 @@ const result = MCPCapability.parse(data);
250301
| **version** | `string` | ✅ | |
251302
| **createdAt** | `string` | optional | |
252303
| **updatedAt** | `string` | optional | |
304+
| **streaming** | `Object` | optional | Streaming configuration |
305+
| **toolApproval** | `Object` | optional | Tool approval configuration |
306+
| **sampling** | `Object` | optional | LLM sampling configuration |
253307

254308

255309
---
@@ -270,6 +324,22 @@ const result = MCPCapability.parse(data);
270324
| **documentation** | `string` | optional | Documentation URL |
271325

272326

327+
---
328+
329+
## MCPStreamingConfig
330+
331+
Streaming configuration for MCP communication
332+
333+
### Properties
334+
335+
| Property | Type | Required | Description |
336+
| :--- | :--- | :--- | :--- |
337+
| **enabled** | `boolean` | ✅ | Enable streaming for MCP communication |
338+
| **chunkSize** | `integer` | optional | Size of each streamed chunk in bytes |
339+
| **heartbeatIntervalMs** | `integer` | ✅ | Heartbeat interval in milliseconds |
340+
| **backpressure** | `Enum<'drop' \| 'buffer' \| 'block'>` | optional | Backpressure handling strategy |
341+
342+
273343
---
274344

275345
## MCPTool
@@ -295,6 +365,22 @@ const result = MCPCapability.parse(data);
295365
| **version** | `string` | ✅ | |
296366

297367

368+
---
369+
370+
## MCPToolApproval
371+
372+
Tool approval configuration for MCP
373+
374+
### Properties
375+
376+
| Property | Type | Required | Description |
377+
| :--- | :--- | :--- | :--- |
378+
| **requireApproval** | `boolean` | ✅ | Require approval before tool execution |
379+
| **approvalStrategy** | `Enum<'human_in_loop' \| 'auto_approve' \| 'policy_based'>` | ✅ | Approval strategy for tool execution |
380+
| **dangerousToolPatterns** | `string[]` | optional | Regex patterns for tools needing approval |
381+
| **autoApproveTimeout** | `integer` | optional | Auto-approve timeout in seconds |
382+
383+
298384
---
299385

300386
## MCPToolCallRequest

‎content/docs/references/ai/meta.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
"devops-agent",
99
"feedback-loop",
1010
"mcp",
11+
"metadata-persistence",
1112
"model-registry",
1213
"nlq",
1314
"orchestration",

‎content/docs/references/ai/metadata-persistence.mdx‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: Metadata Persistence
3+
description: Metadata Persistence protocol schemas
4+
---
5+
6+
{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs go in content/docs/guides/. */}
7+
8+
<Callout type="info">
9+
**Source:** `packages/spec/src/ai/metadata-persistence.zod.ts`
10+
</Callout>
11+
12+
## TypeScript Usage
13+
14+
```typescript
15+
import { MetadataSource } from '@objectstack/spec/ai';
16+
import type { MetadataSource } from '@objectstack/spec/ai';
17+
18+
// Validate data
19+
const result = MetadataSource.parse(data);
20+
```
21+
22+
---
23+
24+
## MetadataSource
25+
26+
### Properties
27+
28+
| Property | Type | Required | Description |
29+
| :--- | :--- | :--- | :--- |
30+
| **file** | `string` | optional | |
31+
| **line** | `number` | optional | |
32+
| **column** | `number` | optional | |
33+
| **package** | `string` | optional | |
34+
| **object** | `string` | optional | |
35+
| **field** | `string` | optional | |
36+
| **component** | `string` | optional | |
37+
38+
39+
---
40+

‎content/docs/references/ai/model-registry.mdx‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: Model Registry
33
description: Model Registry protocol schemas
44
---
55

6+
{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs go in content/docs/guides/. */}
7+
68
AI Model Registry Protocol
79

810
Centralized registry for managing AI models, prompt templates, and model versioning.

0 commit comments

Comments
 (0)