project_docs
Retrieve or update network project documentation such as IP schemes, credentials, diagrams, and troubleshooting notes.
Instructions
Manage project documentation (CRUD operations)
v0.47.0: CRUD-style consolidation of get_project_readme and update_project_readme.
Actions: - get: Read project README/notes (markdown format) - update: Write project README/notes
Project documentation typically includes: - IP addressing schemes and VLANs - Node credentials (usernames, password vault keys) - Architecture diagrams (text-based) - Configuration templates and snippets - Troubleshooting notes and runbooks
Returns: JSON with project_id and markdown content or success confirmation
Examples: # Get README >>> project_docs(action="get") >>> project_docs(action="get", project_id="a920c77d-6e9b-41b8-9311-b4b866a2fbb0")
# Update README
>>> project_docs(action="update", content="""
... # HA PowerDNS
... ## IPs
... - B-Rec1: 10.2.0.1/24
... - B-Rec2: 10.2.0.2/24
... """)Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| action | Yes | Action: 'get' (read README) or 'update' (write README) | |
| content | No | Markdown content (required for 'update') | |
| project_id | No | Project ID (uses current project if not specified) |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |