Skip to content

Commit 20f543f

Browse files
authored
docs: document edit-wiki-page safe output tool and add to architecture tree (#63)
1 parent 7b4536f commit 20f543f

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ Alongside the correctly generated pipeline yaml, an agent file is generated from
4141
│ ├── mod.rs
4242
│ ├── create_pr.rs
4343
│ ├── create_work_item.rs
44+
│ ├── edit_wiki_page.rs
4445
│ ├── memory.rs
4546
│ ├── missing_data.rs
4647
│ ├── missing_tool.rs
@@ -893,6 +894,27 @@ safe-outputs:
893894
- Content validation: text files are scanned for `##vso[` commands
894895
- Extension filtering: can restrict to specific file types
895896

897+
#### edit-wiki-page
898+
Updates the content of an existing Azure DevOps wiki page. The wiki page must already exist; this tool edits its content but does not create new pages.
899+
900+
**Agent parameters:**
901+
- `path` - Wiki page path to update (e.g. `/Overview/Architecture`). Must not be empty and must not contain `..`.
902+
- `content` - Markdown content for the wiki page (at least 10 characters).
903+
- `comment` *(optional)* - Commit comment describing the change. Defaults to the value configured in the front matter, or `"Updated by agent"` if not set.
904+
905+
**Configuration options (front matter):**
906+
```yaml
907+
safe-outputs:
908+
edit-wiki-page:
909+
wiki-name: "MyProject.wiki" # Required — wiki identifier (name or GUID)
910+
wiki-project: "OtherProject" # Optional — ADO project that owns the wiki; defaults to current pipeline project
911+
path-prefix: "/agent-output" # Optional — prepended to the agent-supplied path (restricts write scope)
912+
title-prefix: "[Agent] " # Optional — prepended to the last path segment (the page title)
913+
comment: "Updated by agent" # Optional — default commit comment when agent omits one
914+
```
915+
916+
Note: `wiki-name` is required. If it is not set, execution fails with an explicit error message.
917+
896918
### Adding New Features
897919

898920
When extending the compiler:

0 commit comments

Comments
 (0)