Skip to main content

Populate an in-warehouse agents.* schema from dbt manifests, OSI YAML, and LookML.

Project description

Agents Schema

Agents need context to answer questions about warehouse data. Agents Schema puts that context in the warehouse itself, in a standard AGENTS schema, so agents can query metadata next to the data they are reasoning over. See Why Agents Schema for more on the idea behind it and SPEC.md for the schema contract.

This repository provides GitHub workflows that ingest source metadata from your repository and publish it into AGENTS.

Agents Schema overview

Run one of the workflows below to populate the AGENTS schema from a source you already have. Once it's populated, anything that already queries your warehouse can read those tables as ordinary SQL, including Cursor, Claude Code, notebooks, and internal agents. The fastest path is usually dbt: if your repo already produces target/manifest.json, the workflow only needs the dbt project path and your warehouse credentials.

After the first run, your warehouse has queryable metadata tables such as AGENTS.DBT_MODEL, AGENTS.LOOKML_VIEW, or AGENTS.OSI_DATASET. Agents can use those tables to understand which models and semantic objects exist, how they are documented, how they relate to the warehouse, and what context is available before writing or explaining queries.

Contents

Getting Started

There are three supported metadata sources. Pick one to get started quickly.

Prerequisites

Each workflow writes to your warehouse using a single GitHub Actions secret: WAREHOUSE_CREDENTIALS. The source-specific setup guides show the expected secret shape and the workflow YAML to copy.

Guides

Sync dbt

Use dbt Setup Guide when your repository contains a dbt project or an existing target/manifest.json.

Sync Looker

Use Looker Setup Guide when your repository contains LookML files.

Sync OSI

Use OSI Setup Guide when your repository contains Open Semantic Interchange *.osi.yaml files.

Sync Multiple Sources

Use the reusable workflows together when one repository contains multiple metadata sources. See examples/workflows/dbt-looker.yml and examples/workflows/dbt-looker-osi.yml.

Query with an agent

Once AGENTS is populated, the agents-schema-analyst skill lets an AI agent answer questions about your warehouse — grounded in your real metric definitions from AGENTS.*, not guesses. You need a snow CLI connection (run snow connection add if you don't have one).

Claude Code

curl -fsSL --create-dirs \
  -o ~/.claude/skills/agents-schema-analyst/SKILL.md \
  https://raw.githubusercontent.com/fivetran/agents_schema/v0.0.6/examples/skills/agents-schema-analyst/SKILL.md

Then ask: /agents-schema-analyst "What is our total MRR this month?"

Codex

curl -fsSL --create-dirs \
  -o ~/.codex/skills/agents-schema-analyst/SKILL.md \
  https://raw.githubusercontent.com/fivetran/agents_schema/v0.0.6/examples/skills/agents-schema-analyst/SKILL.md

Then ask: $agents-schema-analyst "What is our total MRR this month?"

Why Agents Schema

Agents operating over a warehouse need context that is not captured in table schemas alone: what a table is for, who maintains it, what transformations produced it, what it costs to query, and how it relates to other tables. Today this information often lives in wikis, Slack threads, dashboards, and tribal knowledge. Agents Schema puts it in the warehouse itself, where agents can find it without leaving the query interface.

Agents Schema is a discovery layer for agents that already query your warehouse. It gives them a standard place to ask: what curated tables exist, which system published the metadata, what dbt model or LookML object backs a dataset, what OSI semantic model describes it, whether a source is stale, and who owns a data product.

The schema is self-documenting. AGENTS.ROOT tells consumers which providers are present and explains what provider-contributed tables mean. Consumers can start there for generic discovery, or query well-known extension tables directly when they already know the shape they need.

Agents Schema is not a replacement for specialized systems, source-native metadata APIs, or development-time tooling. A dbt MCP server helping an agent edit a dbt repository should still use dbt source files and artifacts directly. Agents Schema is the shared, queryable metadata surface for consumers that start from the warehouse and need context about data that already exists there.

It is closest in spirit to information_schema, but extensible across many providers. Compared with MCP servers, Agents Schema is narrower: it publishes context inside the warehouse, while MCP servers can expose tools, actions, and source-specific workflows.

How it works

  1. A workflow in your repository invokes one of this repo's workflows.
  2. The workflow checks out your repository and reads source metadata such as dbt artifacts, LookML files, or OSI YAML files.
  3. The workflow runs the agents-schema CLI at the pinned release tag.
  4. The CLI writes normalized metadata into the warehouse under the AGENTS schema.
  5. Agents and downstream tools query AGENTS for context close to the data itself.

Reference

CLI

The GitHub Actions call the CLI with explicit source arguments:

agents-schema dbt --project-dir dbt_project
agents-schema looker --lookml-dir lookml
agents-schema osi --osi-dir osi

The CLI reads warehouse credentials from WAREHOUSE_CREDENTIALS.

Versioning

Release tags version the whole repository: reusable workflows, actions, CLI source, examples, README, and spec.

Pin exact tags in your workflows:

uses: fivetran/agents_schema/.github/workflows/agents-schema-dbt.yml@v0.0.6

To upgrade, change only the tag in the uses: line. The current release tag is v0.0.6.

Specification

The full schema contract is in SPEC.md. Keep schema definitions and compatibility rules there; keep this README focused on installation and source-specific GitHub workflow usage.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

agents_schema-0.0.6.tar.gz (105.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

agents_schema-0.0.6-py3-none-any.whl (17.4 kB view details)

Uploaded Python 3

File details

Details for the file agents_schema-0.0.6.tar.gz.

File metadata

  • Download URL: agents_schema-0.0.6.tar.gz
  • Upload date:
  • Size: 105.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for agents_schema-0.0.6.tar.gz
Algorithm Hash digest
SHA256 a2f615b621c919be065bc86fec2f3e3f56711ede9ebe76a2056033e19848e31b
MD5 df36f038e86f05cd440a9ebb75cc7834
BLAKE2b-256 7de55802a946d074358a73e7624bb82c765e64282109363e9ff5b3f409aa9f03

See more details on using hashes here.

Provenance

The following attestation bundles were made for agents_schema-0.0.6.tar.gz:

Publisher: publish-pypi.yml on fivetran/agents_schema

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file agents_schema-0.0.6-py3-none-any.whl.

File metadata

  • Download URL: agents_schema-0.0.6-py3-none-any.whl
  • Upload date:
  • Size: 17.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for agents_schema-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 d7147b59c6c6581726648ba87afb6f96632d8079070b1adcde98f5d0fc475454
MD5 bf51035302dbc0d2faaa242e56bfe349
BLAKE2b-256 53ebbbe59f92469afef9e336ae3ac62b9ead7d8e8e7e746ef8db7dad6a55a302

See more details on using hashes here.

Provenance

The following attestation bundles were made for agents_schema-0.0.6-py3-none-any.whl:

Publisher: publish-pypi.yml on fivetran/agents_schema

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page