Generate Query Documentation
ob_generate_query_docGenerate JSON or Markdown documentation for SQL queries without executing them, enabling safe inspection.
Instructions
Generate bounded JSON or Markdown documentation for a SQL snippet without executing the target query.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "ob_generate_query_doc"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sql | No | ||
| line | No | ||
| title | No | ||
| format | No | markdown | |
| params | No | ||
| schema | No | ||
| maxRows | No | ||
| profile | No | ||
| filePath | No | ||
| runExplain | No |