Generate Table Documentation
ob_generate_table_docGenerate JSON or Markdown documentation for one table in OceanBase database, with options for title, schema, and inclusion of relationships and query examples.
Instructions
Generate bounded JSON or Markdown documentation for one visible table without returning sample values.
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": {
"table": "<table>"
},
"name": "ob_generate_table_doc"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| table | Yes | ||
| title | No | ||
| format | No | markdown | |
| schema | No | ||
| profile | No | ||
| maxColumns | No | ||
| maxExamples | No | ||
| relationshipLimit | No | ||
| includeQueryExamples | No | ||
| includeRelationships | No |