docs
Generate a comprehensive documentation website for your project using the dbt-mcp server. Automate the process of creating and maintaining up-to-date project documentation.
Instructions
The docs command is responsible for generating your project's documentation website.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/dbt_mcp/dbt_cli/tools.py:107-108 (handler)Handler function for the 'docs' tool. Executes `dbt docs generate` command using the shared _run_dbt_command utility.
def docs() -> str: return _run_dbt_command(["docs", "generate"]) - src/dbt_mcp/dbt_cli/tools.py:201-210 (registration)Registration of the 'docs' tool via ToolDefinition, specifying the handler function, description from prompts, and annotations indicating it's read-only, non-destructive, and idempotent.
ToolDefinition( fn=docs, description=get_prompt("dbt_cli/docs"), annotations=create_tool_annotations( title="dbt docs", read_only_hint=True, destructive_hint=False, idempotent_hint=True, ), ), - Definition of the tool name constant ToolName.DOCS = "docs" used throughout the codebase for referencing the tool.
DOCS = "docs" - src/dbt_mcp/tools/policy.py:35-37 (helper)Policy definition for the 'docs' tool, classifying its behavior as METADATA (no row-level data).
ToolName.DOCS.value: ToolPolicy( name=ToolName.DOCS.value, behavior=ToolBehavior.METADATA ), - src/dbt_mcp/tools/toolsets.py:72-72 (helper)Inclusion of the 'docs' tool in the DBT_CLI toolset.
ToolName.DOCS,