# Knowledge Catalog Documentation

> Reference for Knowledge Catalog context engineering: Open Knowledge Format bundles, Metadata as Code (kcmd) sync, enrichment agents, discovery samples, and evaluation workflows for data stewards and agent builders.

This is a Grok-Wiki source-grounded repository documentation set. Use the complete Markdown link when an agent needs the full repo context.

## Context Links

- [Complete Markdown docs](https://www.grok-wiki.com/public/docs/googlecloudplatform-knowledge-catalog-9cee6ee3cba5/llms-full.txt)
- [Complete Markdown alias](https://www.grok-wiki.com/public/docs/googlecloudplatform-knowledge-catalog-9cee6ee3cba5.md)
- [Human interactive docs](https://www.grok-wiki.com/public/docs/googlecloudplatform-knowledge-catalog-9cee6ee3cba5)
- [GitHub repository](https://github.com/GoogleCloudPlatform/knowledge-catalog)

## Repository

- Repository: GoogleCloudPlatform/knowledge-catalog
- Branch: main
- Generated: 2026-06-15T02:58:52.928Z
- Updated: 2026-06-15T03:01:11.890Z
- Runtime: Grok CLI
- Format: Documentation
- Pages: 22

## Pages

- [Overview](https://www.grok-wiki.com/public/docs/googlecloudplatform-knowledge-catalog-9cee6ee3cba5/pages/01-overview.md): Knowledge Catalog tooling surface: OKF bundles, kcmd Metadata as Code workspaces, enrichment and discovery agents, and the shortest paths to produce and publish metadata context.
- [Installation](https://www.grok-wiki.com/public/docs/googlecloudplatform-knowledge-catalog-9cee6ee3cba5/pages/02-installation.md): Prerequisites, Python and Node.js setup, package installs, and credential configuration for BigQuery, Vertex AI or Gemini, and gcloud Application Default Credentials.
- [Quickstart](https://www.grok-wiki.com/public/docs/googlecloudplatform-knowledge-catalog-9cee6ee3cba5/pages/03-quickstart.md): First successful runs: initialize a kcmd workspace and pull metadata, produce an OKF bundle from BigQuery, or run the catalog enrichment agent and inspect output.
- [Open Knowledge Format](https://www.grok-wiki.com/public/docs/googlecloudplatform-knowledge-catalog-9cee6ee3cba5/pages/04-open-knowledge-format.md): OKF v0.1 bundle structure, concept documents, frontmatter fields, index.md progressive disclosure, and cross-link semantics for vendor-neutral knowledge exchange.
- [Metadata as Code](https://www.grok-wiki.com/public/docs/googlecloudplatform-knowledge-catalog-9cee6ee3cba5/pages/05-metadata-as-code.md): kcmd workspace model: catalog.yaml manifest, YAML and Markdown layouts, pull/push sync, reference layers, entry links, and glossary scope for Knowledge Catalog metadata.
- [Enrichment workflows](https://www.grok-wiki.com/public/docs/googlecloudplatform-knowledge-catalog-9cee6ee3cba5/pages/06-enrichment-workflows.md): How enrichment agents read source metadata, ground on external docs or code, emit OKF bundles or mdcode artifacts, and hand off to kcmd push for catalog publication.
- [Sync catalog metadata](https://www.grok-wiki.com/public/docs/googlecloudplatform-knowledge-catalog-9cee6ee3cba5/pages/07-sync-catalog-metadata.md): Initialize a kcmd workspace for BigQuery, knowledge base, entry group, BigLake, or glossary scope; pull snapshots; check status; and push local edits back to Knowledge Catalog.
- [Produce OKF bundles](https://www.grok-wiki.com/public/docs/googlecloudplatform-knowledge-catalog-9cee6ee3cba5/pages/08-produce-okf-bundles.md): Run the OKF enrichment agent against a BigQuery source with optional web crawl seeds, concept scoping, and two-pass BQ-then-web enrichment into a versionable bundle directory.
- [Run the catalog enrichment agent](https://www.grok-wiki.com/public/docs/googlecloudplatform-knowledge-catalog-9cee6ee3cba5/pages/09-run-the-catalog-enrichment-agent.md): Execute table, doc, or context_overlay modes with Drive, local markdown, GitHub, feedback, glossary, and usage-signal inputs; refine output interactively before publishing.
- [Publish enriched metadata](https://www.grok-wiki.com/public/docs/googlecloudplatform-knowledge-catalog-9cee6ee3cba5/pages/10-publish-enriched-metadata.md): Push mdcode workspaces with kcmd, publish sample enrichment output via catalog APIs, and reconcile entry links and aspects without modifying read-only reference layers.
- [Visualize OKF bundles](https://www.grok-wiki.com/public/docs/googlecloudplatform-knowledge-catalog-9cee6ee3cba5/pages/11-visualize-okf-bundles.md): Generate self-contained viz.html graph viewers from OKF bundles with force-directed layouts, concept detail panels, backlinks, and in-browser markdown rendering.
- [Run the discovery agent](https://www.grok-wiki.com/public/docs/googlecloudplatform-knowledge-catalog-9cee6ee3cba5/pages/12-run-the-discovery-agent.md): Deploy the Knowledge Catalog discovery agent with ADK: required GCP APIs and IAM roles, environment variables, and root-agent or AgentTool integration patterns.
- [Evaluate enrichment output](https://www.grok-wiki.com/public/docs/googlecloudplatform-knowledge-catalog-9cee6ee3cba5/pages/13-evaluate-enrichment-output.md): Score enrichment runs with dynamic golden-free metrics or golden-based eval: structural validity, hallucination checks, fact recall, consistency across runs, and report artifacts.
- [kcmd CLI reference](https://www.grok-wiki.com/public/docs/googlecloudplatform-knowledge-catalog-9cee6ee3cba5/pages/14-kcmd-cli-reference.md): kcmd commands, init flags per source type, pull and push options including dry-run, force, validate-only, reference pull, and authentication via gcloud ADC.
- [catalog.yaml manifest reference](https://www.grok-wiki.com/public/docs/googlecloudplatform-knowledge-catalog-9cee6ee3cba5/pages/15-catalog.yaml-manifest-reference.md): scope, snapshot, publishing, reference, aliases, entry and aspect types, entryLinks reconciliation rules, and layout selection for YAML versus Markdown knowledge-base mode.
- [kcmd MCP server reference](https://www.grok-wiki.com/public/docs/googlecloudplatform-knowledge-catalog-9cee6ee3cba5/pages/16-kcmd-mcp-server-reference.md): MCP server startup, workspace path binding, and agent tools for pull, push, list-entries, lookup-entry, and modify-entry in agentic metadata workflows.
- [OKF enrichment-agent CLI reference](https://www.grok-wiki.com/public/docs/googlecloudplatform-knowledge-catalog-9cee6ee3cba5/pages/17-okf-enrichment-agent-cli-reference.md): enrichment-agent enrich and visualize subcommands, BigQuery source flags, web crawl constraints, concept scoping, model selection, and environment variables.
- [Enrichment agent flags reference](https://www.grok-wiki.com/public/docs/googlecloudplatform-knowledge-catalog-9cee6ee3cba5/pages/18-enrichment-agent-flags-reference.md): agent_runner.py flags by mode: table, doc, context_overlay; source inputs, usage signal, glossaries, feedback, GitHub MCP, refinement, and required Vertex project and model values.
- [OKF bundle recipes](https://www.grok-wiki.com/public/docs/googlecloudplatform-knowledge-catalog-9cee6ee3cba5/pages/19-okf-bundle-recipes.md): Copy-paste enrichment recipes for GA4 merchandise store, Stack Overflow, and Bitcoin public datasets with seed files, exact commands, and expected bundle outputs.
- [Toolbox enrichment demo](https://www.grok-wiki.com/public/docs/googlecloudplatform-knowledge-catalog-9cee6ee3cba5/pages/20-toolbox-enrichment-demo.md): End-to-end TypeScript demo: kcmd init and pull, kcagent enrich with md-fileset MCP tools, fileset skills, prompt configuration, and BigQuery demo dataset setup.
- [Troubleshooting](https://www.grok-wiki.com/public/docs/googlecloudplatform-knowledge-catalog-9cee6ee3cba5/pages/21-troubleshooting.md): Common auth, billing, push conflict, web crawl cap, glossary provisioning, and model credential failures with verification signals from tests and README constraints.
- [Contributing](https://www.grok-wiki.com/public/docs/googlecloudplatform-knowledge-catalog-9cee6ee3cba5/pages/22-contributing.md): CLA requirements, fork-and-PR workflow, style expectations, and test commands for Python pytest and TypeScript npm run test across package directories.

## Source Files

- `agents/enrichment/eval/__main__.py`
- `agents/enrichment/eval/dynamic_eval.py`
- `agents/enrichment/eval/golden_eval.py`
- `agents/enrichment/eval/goldens/README.md`
- `agents/enrichment/eval/goldens/TEMPLATE.json`
- `agents/enrichment/eval/metrics.py`
- `agents/enrichment/README.md`
- `agents/enrichment/src/agent_runner.py`
- `agents/enrichment/src/engine.py`
- `agents/enrichment/src/linking.py`
- `agents/enrichment/src/modes/context_overlay_mode.py`
- `agents/enrichment/src/modes/doc_mode.py`
- `agents/enrichment/src/modes/table_mode.py`
- `agents/enrichment/src/refine.py`
- `agents/enrichment/src/requirements.txt`
- `agents/enrichment/src/tools/bq_usage_tools.py`
- `agents/enrichment/src/tools/feedback_tools.py`
- `agents/enrichment/src/tools/github_tools.py`
- `agents/enrichment/src/tools/kcmd_tools.py`
- `agents/mdcode/docs/concept.md`
- `agents/mdcode/docs/design.md`
- `agents/mdcode/package.json`
- `agents/mdcode/README.md`
- `agents/mdcode/src/libts/gcp/context.ts`
- `agents/mdcode/src/libts/layout.ts`
- `agents/mdcode/src/libts/manifest.ts`
- `agents/mdcode/src/libts/snapshot.ts`
- `agents/mdcode/src/libts/sync.ts`
- `agents/mdcode/src/tool/commands.ts`
- `agents/mdcode/src/tool/main.ts`
- `agents/mdcode/src/tool/mcp.ts`
- `CODE_OF_CONDUCT.md`
- `CONTRIBUTING.md`
- `LICENSE.md`
- `okf/bundles/crypto_bitcoin/index.md`
- `okf/bundles/stackoverflow/datasets/stackoverflow.md`
- `okf/bundles/stackoverflow/index.md`
- `okf/pyproject.toml`
- `okf/README.md`
- `okf/samples/crypto_bitcoin/README.md`
- `okf/samples/ga4_merch_store/README.md`
- `okf/samples/ga4_merch_store/seeds.txt`
- `okf/samples/stackoverflow/README.md`
- `okf/samples/stackoverflow/seeds.txt`
- `okf/SPEC.md`
- `okf/src/enrichment_agent/agent.py`
- `okf/src/enrichment_agent/bundle/document.py`
- `okf/src/enrichment_agent/bundle/index.py`
- `okf/src/enrichment_agent/bundle/paths.py`
- `okf/src/enrichment_agent/cli.py`
- `okf/src/enrichment_agent/prompts/enrichment_instruction.md`
- `okf/src/enrichment_agent/prompts/web_ingestion_instruction.md`
- `okf/src/enrichment_agent/runner.py`
- `okf/src/enrichment_agent/sources/bigquery.py`
- `okf/src/enrichment_agent/tools/web_tools.py`
- `okf/src/enrichment_agent/viewer/generator.py`
- `okf/src/enrichment_agent/viewer/static/viz.css`
- `okf/src/enrichment_agent/viewer/static/viz.js`
- `okf/src/enrichment_agent/viewer/templates/viz.html`
- `okf/src/enrichment_agent/web/fetcher.py`
- `okf/tests/test_bigquery_source.py`
- `okf/tests/test_web_fetcher.py`
- `README.md`
- `samples/discovery/agent.py`
- `samples/discovery/README.md`
- `samples/discovery/requirements.txt`
- `samples/discovery/SKILL.md`
- `samples/discovery/tools.py`
- `samples/discovery/utils.py`
- `samples/enrichment/README.md`
- `samples/enrichment/src/enrichment/enrich.py`
- `samples/enrichment/src/enrichment/publish.py`
- `samples/enrichment/src/env.sh`
- `samples/enrichment/src/tools/fileskb/README.md`
- `samples/README.md`
- `toolbox/enrichment/package.json`
- `toolbox/enrichment/README.md`
- `toolbox/enrichment/src/agent/enrich/agent.ts`
- `toolbox/enrichment/src/agent/enrich/command.ts`
- `toolbox/enrichment/src/tools/md/server.ts`
- `toolbox/mdcode/docs/concept.md`
- `toolbox/mdcode/docs/spec.md`
- `toolbox/mdcode/README.md`
- `toolbox/mdcode/src/tool/commands.ts`
- `toolbox/mdcode/src/tool/main.ts`
- `toolbox/mdcode/src/tool/mcp.ts`
- `toolbox/README.md`