Generate Onboarding Documentation
ob_generate_onboarding_docGenerate onboarding documentation from OceanBase metadata and optional business glossary hints to help new users understand database structure.
Instructions
Generate bounded onboarding documentation from visible OceanBase metadata and optional business glossary hints.
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_onboarding_doc"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| title | No | ||
| format | No | markdown | |
| schema | No | ||
| profile | No | ||
| maxTables | No | ||
| tablePattern | No | ||
| businessTerms | No | ||
| maxCoreTables | No | ||
| relationshipLimit | No | ||
| maxColumnsPerTable | No |