Skip to content

Commit 5425af7

Browse files
authored
Merge pull request OWASP#47 from zenitysec/dev
New Github Pages URL and fix broken links
2 parents c7737ce + fc65d97 commit 5425af7

4 files changed

Lines changed: 26 additions & 25 deletions

File tree

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
.idea/
2-
.git/
2+
.git/
3+
book/

CLAUDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ The documentation follows this hierarchy:
9090
This is a documentation-focused project built with:
9191
- **UV** for Python dependency management (replaces pip)
9292
- **MkDocs Material** for documentation generation
93-
- **GitHub Pages** for hosting at improved-adventure-3jj129k.pages.github.io
93+
- **GitHub Pages** for hosting at zenitysec.github.io/AOS/
9494

9595
### Roadmap Context
9696
- **v0.1** (Current): Documentation, schemas, and requirements

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The standard covers the following aspects
2626

2727
## Getting Started
2828

29-
- 📚 **Explore the Documentation:** Visit the [Documentation Site](https://improved-adventure-3jj129k.pages.github.io/) for a complete overview, the full specification, tutorials, and guides.
29+
- 📚 **Explore the Documentation:** Visit the [Documentation Site](https://zenitysec.github.io/AOS/) for a complete overview, the full specification, tutorials, and guides.
3030
- 📝 **View the Specification:** [Specification](https://github.com/zenitysec/AOS/tree/main/specification)
3131

3232
## Contributing

docs/spec/instrument/specification.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -179,8 +179,8 @@ It **MUST** be one of the following:
179179
For conveying plain textual content.
180180

181181

182-
| Field Name | Type | Required | Description |
183-
| :--------- | :-------------------- | :------- | :-------------------------------------------- |
182+
| Field Name | Type | Required | Description |
183+
| :---------------------------------- | :----------------------------------------------------------------- | :------- | :------------------------------------------------------------------------------------------------------------------------------------------ |
184184
| `kind` | `"text"` (literal) | Yes | Identifies this part as textual content. |
185185
| `text` | `string` | Yes | The textual content of the part. |
186186
| `metadata` | `Record<string, any>` | No | Optional metadata specific to this text part. |
@@ -433,8 +433,8 @@ This method should be used after the agent's input is extracted from the trigger
433433
| `trigger` | [`AgentTrigger`](#36-agenttrigger-object) | Yes | The trigger that activated the agent. |
434434

435435

436-
#### 4.1.2. **Response on success**: [`AOSSuccessResponse`](#51-AOSSuccessResponse-object).
437-
#### 4.1.3. **Response on failure**: [`JSONRPCErrorResponse`](#313-jsonrpcerrorresonse-object).
436+
#### 4.1.2. **Response on success**: [`AOSSuccessResponse`](#51-aossuccessresponse-object).
437+
#### 4.1.3. **Response on failure**: [`JSONRPCErrorResponse`](#52-jsonrpcerrorresonse-object).
438438

439439

440440
### 4.2. steps/knowledgeRetrieval
@@ -453,8 +453,8 @@ There are many retrieval techniques including semantic search (embedding-based s
453453
| `reasoning` | `string` | No | Agent's reasoning. |
454454

455455

456-
#### 4.2.2. **Response on success**: [`AOSSuccessResponse`](#51-AOSsuccessresponse-object).
457-
#### 4.2.3. **Response on failure**: [`JSONRPCErrorResponse`](#313-jsonrpcerrorresonse-object).
456+
#### 4.2.2. **Response on success**: [`AOSSuccessResponse`](#51-aossuccessresponse-object).
457+
#### 4.2.3. **Response on failure**: [`JSONRPCErrorResponse`](#52-jsonrpcerrorresonse-object).
458458

459459
### 4.3. steps/memoryStore
460460
This step refers to the process of memorizing and store memory to the memory store for additional context for future or current agent interactions.<br>
@@ -469,8 +469,8 @@ Mostly, interaction history or a summary is stored to the memory store.
469469
| `reasoning` | `string` | No | Agent's reasoning. |
470470

471471

472-
#### 4.3.2. **Response on success**: [`AOSSuccessResponse`](#51-AOSsuccessresponse-object).
473-
#### 4.3.3. **Response on failure**: [`JSONRPCErrorResponse`](#313-jsonrpcerrorresonse-object).
472+
#### 4.3.2. **Response on success**: [`AOSSuccessResponse`](#51-aossuccessresponse-object).
473+
#### 4.3.3. **Response on failure**: [`JSONRPCErrorResponse`](#52-jsonrpcerrorresonse-object).
474474

475475

476476
### 4.4. steps/memoryContextRetrieval
@@ -487,8 +487,8 @@ This context is passed alongside with the agent's instructions(system prompt), u
487487
| `reasoning` | `string` | No | Agent's reasoning. |
488488

489489

490-
#### 4.4.2. **Response on success**: [`AOSSuccessResponse`](#51-AOSsuccessresponse-object).
491-
#### 4.4.3. **Response on failure**: [`JSONRPCErrorResponse`](#313-jsonrpcerrorresonse-object).
490+
#### 4.4.2. **Response on success**: [`AOSSuccessResponse`](#51-aossuccessresponse-object).
491+
#### 4.4.3. **Response on failure**: [`JSONRPCErrorResponse`](#52-jsonrpcerrorresonse-object).
492492

493493

494494
### 4.5. steps/message
@@ -508,8 +508,8 @@ A message with `system` role represents a message from the system, such as guard
508508
| `reasoning` | `string` | No | Agent's reasoning. Should be used with `agent` or `system` message. |
509509

510510

511-
#### 4.5.2. **Response on success**: [`AOSSuccessResponse`](#51-AOSsuccessresponse-object).
512-
#### 4.5.3. **Response on failure**: [`JSONRPCErrorResponse`](#313-jsonrpcerrorresonse-object).
511+
#### 4.5.2. **Response on success**: [`AOSSuccessResponse`](#51-aossuccessresponse-object).
512+
#### 4.5.3. **Response on failure**: [`JSONRPCErrorResponse`](#52-jsonrpcerrorresonse-object).
513513

514514

515515
### 4.6. steps/toolCallRequest
@@ -527,8 +527,8 @@ This method should be used after tool inputs are inferred by the LLM and before
527527

528528

529529

530-
#### 4.5.2. **Response on success**: [`AOSSuccessResponse`](#51-AOSsuccessresponse-object).
531-
#### 4.5.3. **Response on failure**: [`JSONRPCErrorResponse`](#313-jsonrpcerrorresonse-object).
530+
#### 4.5.2. **Response on success**: [`AOSSuccessResponse`](#51-aossuccessresponse-object).
531+
#### 4.5.3. **Response on failure**: [`JSONRPCErrorResponse`](#52-jsonrpcerrorresonse-object).
532532

533533
### 4.6. steps/toolCallResult
534534
This method should be used after tool is completed and before the result goes back into the LLM for further processing.
@@ -550,8 +550,8 @@ This method should be used after tool is completed and before the result goes ba
550550
| `isError` |`boolean`| Yes | Whether tool completed successfully or resulted in an error. |
551551

552552

553-
#### 4.6.2. **Response on success**: [`AOSSuccessResponse`](#51-AOSsuccessresponse-object).
554-
#### 4.6.3. **Response on failure**: [`JSONRPCErrorResponse`](#313-jsonrpcerrorresonse-object).
553+
#### 4.6.2. **Response on success**: [`AOSSuccessResponse`](#51-aossuccessresponse-object).
554+
#### 4.6.3. **Response on failure**: [`JSONRPCErrorResponse`](#52-jsonrpcerrorresonse-object).
555555

556556

557557
### 4.7. protocols/A2A
@@ -569,8 +569,8 @@ Read more about A2A support in [extend_a2a](../instrument/extend_a2a.md).
569569
| `message` | `object` | Yes | A2A-compliant message. |
570570
| `reasoning` | `string` | No | Agent's reasoning. |
571571

572-
#### 4.7.2. **Response on success**: [`AOSSuccessResponse`](#51-AOSsuccessresponse-object).
573-
#### 4.7.3. **Response on failure**: [`JSONRPCErrorResponse`](#313-jsonrpcerrorresonse-object).
572+
#### 4.7.2. **Response on success**: [`AOSSuccessResponse`](#51-aossuccessresponse-object).
573+
#### 4.7.3. **Response on failure**: [`JSONRPCErrorResponse`](#52-jsonrpcerrorresonse-object).
574574

575575
### 4.8. protocols/MCP
576576
This method should be used to wrap all [MCP](https://modelcontextprotocol.io/introduction) communications and messages.<br>
@@ -587,8 +587,8 @@ Read more about MCP support in [extend_mcp](../instrument/extend_mcp.md).
587587
| `message` | `object` | Yes | MCP-compliant message. |
588588
| `reasoning` | `string` | No | Agent's reasoning. |
589589

590-
#### 4.8.2. **Response on success**: [`AOSSuccessResponse`](#51-AOSsuccessresponse-object).
591-
#### 4.8.3. **Response on failure**: [`JSONRPCErrorResponse`](#313-jsonrpcerrorresonse-object).
590+
#### 4.8.2. **Response on success**: [`AOSSuccessResponse`](#51-aossuccessresponse-object).
591+
#### 4.8.3. **Response on failure**: [`JSONRPCErrorResponse`](#52-jsonrpcerrorresonse-object).
592592

593593
### 4.9. ping
594594
This method is used by the agent to ensure that guardian agent is alive.
@@ -604,7 +604,7 @@ This method is used by the agent to ensure that guardian agent is alive.
604604
| `metadata` | `Record<string, any>` | No | Arbitrary key-value metadata associated with the agent. |
605605

606606
#### 4.9.2. **Response on success**: [`PingRequestSuccessResponse`](#53-pingrequestsuccessresponse-object).
607-
#### 4.9.3. **Response on failure**: [`JSONRPCErrorResponse`](#313-jsonrpcerrorresonse-object).
607+
#### 4.9.3. **Response on failure**: [`JSONRPCErrorResponse`](#52-jsonrpcerrorresonse-object).
608608

609609
## 5. Responses
610610

@@ -613,7 +613,7 @@ This method is used by the agent to ensure that guardian agent is alive.
613613
| :-------------- | :-------------------------------------------------------------- | :------- | :----------------------------------------------------------------- |
614614
| `id` | `string` \| `integer` | Yes | Same id as the id in the correlated request. |
615615
| `jsonrpc` |`"2.0"` (literal)| Yes | JSON-RPC version string. |
616-
| `result` |[`AOSSuccessResult`](#511-AOSsuccessresult-object)| Yes | Success result. |
616+
| `result` |[`AOSSuccessResult`](#511-aossuccessresult-object)| Yes | Success result. |
617617

618618
#### 5.1.1. `AOSSuccessResult` Object
619619

0 commit comments

Comments
 (0)