project_docs
Read and update GNS3 project README notes to store IP schemes, credentials, diagrams, configs, and troubleshooting runbooks in markdown.
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 for 'update' a confirmation with content_length (sent), previous_length and stored_length (read back after the write; a 'warning' is added if the stored text differs from what was sent)
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
... """)Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"action": "<action>"
},
"name": "project_docs"
}
}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 |