document_add_example
Add a named example to an OpenAPI 3.x media type, parameter, or header. Provide node path, name, value, and optional summary and description.
Instructions
Add a named example to a media type, parameter, or header (OpenAPI 3.x)
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": {
"session": "<session>",
"nodePath": "<nodePath>",
"name": "<name>",
"value": "<value>"
},
"name": "document_add_example"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Example name | |
| value | Yes | JSON string with the example value | |
| session | Yes | Session name | |
| summary | No | Example summary | |
| nodePath | Yes | Node path to the media type, parameter, or header | |
| description | No | Example description |