Skip to content

Add toolset design guidance to common AI AGENTS.md#62870

Merged
kaxil merged 1 commit intoapache:mainfrom
astronomer:add-toolset-design-guidance-agents-md
Mar 4, 2026
Merged

Add toolset design guidance to common AI AGENTS.md#62870
kaxil merged 1 commit intoapache:mainfrom
astronomer:add-toolset-design-guidance-agents-md

Conversation

@kaxil
Copy link
Member

@kaxil kaxil commented Mar 4, 2026

The existing AGENTS.md for the common AI provider covers hooks and operators but has no guidance for toolsets. As we start adding more toolset backends alongside SQLToolset, contributors need a clear pattern to follow.

This adds:

  • "One backend per toolset" design principle — each toolset wraps a single execution backend. When a new backend needs the same tool interface, create a new toolset class rather than adding conditional branches. Users compose toolsets via AgentOperator(toolsets=[...]).
  • "Adding a New Toolset" section — covers the four-tool SQL pattern (list_tables, get_schema, query, check_query), shared helper extraction, constructor hygiene (no silently-ignored params), and sequential=True guidance.
  • Toolsets key path added to the Key Paths section.

Why now

With DataFusion and other backends on the horizon, having this guidance upfront keeps new toolset PRs consistent and avoids dual-mode classes that branch on constructor params.

The existing AGENTS.md covers hooks and operators but doesn't mention
toolsets. As we add more toolset backends (DataFusion, etc.) alongside
the existing SQLToolset, having clear guidance upfront will help
contributors follow consistent patterns.

Adds:
- "One backend per toolset" design principle
- "Adding a New Toolset" section with the four-tool pattern and
  constructor hygiene guidelines
- Toolsets path in Key Paths
Copy link
Member

@gopidesupavan gopidesupavan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Love it :)

@kaxil kaxil merged commit fe9bc5b into apache:main Mar 4, 2026
62 checks passed
@kaxil kaxil deleted the add-toolset-design-guidance-agents-md branch March 4, 2026 13:27
1Ninad pushed a commit to 1Ninad/airflow that referenced this pull request Mar 6, 2026
The existing AGENTS.md covers hooks and operators but doesn't mention
toolsets. As we add more toolset backends (DataFusion, etc.) alongside
the existing SQLToolset, having clear guidance upfront will help
contributors follow consistent patterns.

Adds:
- "One backend per toolset" design principle
- "Adding a New Toolset" section with the four-tool pattern and
  constructor hygiene guidelines
- Toolsets path in Key Paths
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants