Skip to content

Troubleshooting

Symptom-first fixes for common setup issues. Package-specific detail remains in packages/*/README.md.

Symptom → fix

SymptomLikely causeWhat to do
manifest.json not found / readiness unavailableWrong or empty --dbt-targetPoint at dbt target/ root; run dbt compile or dbt run
Commands work locally but fail in CIArtifacts not uploaded to CI workspacePublish target/ (or remote URI) before dbt-tools step
dbt-tools-mcp fails to startWrong binary or missing targetUse dbt-tools-mcp; set --dbt-target or DBT_TOOLS_DBT_TARGET; stdio only (not HTTP)
MCP works once then stale dataNew dbt run wrote fresh artifactsCall dbt_tools_refresh on the active target, or set_target again after a cache miss
MCP high memory / many tag prefixesLRU keeps parsed snapshots in RAMCall dbt_tools_clear_cached_targets, lower --max-cached-targets / DBT_TOOLS_MAX_CACHED_TARGETS, or set 0 to disable cache
Web UI empty / no graphmanifest-only or missing run resultsRun Check run health; need run_results.json for execution views
Remote S3/GCS errorsCredentials or path on serverConfigure env on Node (CLI/MCP/web server), not in browser; see Local and remote artifacts and Configuration
No web_url in CLI JSONDBT_TOOLS_WEB_BASE_URL unsetExport base URL of running web app; see Deep links
pnpm site:dev esbuild errorsLegacy browser target in monorepoKeep esnext in docs/site/.vitepress/config.ts (see AGENTS.md)
Published docs missing CSSWrong VitePress baseConfirm base: '/dbt-tools-ts/' in docs/site/.vitepress/config.ts

Artifacts not found

  • Confirm manifest.json and run_results.json exist at the root of your --dbt-target path (web: --target is a local alias).
  • Run dbt compile or dbt run if artifacts are missing or stale.
  • See dbt artifacts & target/ for manifest-only (dbt compile) vs full (dbt run / dbt build / dbt test) and what each file is used for.

Wrong Node version

Published packages require Node.js 20+. Match .node-version when developing from the monorepo.

MCP client cannot start the server

  • Use the full binary name dbt-tools-mcp in MCP config.
  • Pass --dbt-target or set DBT_TOOLS_DBT_TARGET.
  • Check stdio transport: the server is designed for MCP over stdin/stdout, not HTTP.

Web UI shows empty views

  • Verify the target directory contains a complete manifest/run pair for the run you expect.
  • Execution views need run_results.json—a manifest-only target after dbt compile is not enough. See dbt artifacts & target/.
  • For remote sources, pass --dbt-target s3://… or gs://… with optional --gcs-impersonate-service-account (or env) on dbt-tools-web startup; see Web server CLI.

GitHub Pages site issues

If CSS or assets fail to load on the published docs site, confirm VitePress base is /dbt-tools-ts/ for project Pages. After a custom domain migration, update base in docs/site/.vitepress/config.ts.

Get help

Released under the repository license terms.