Ship AGENTS.md and llms-full.txt for agent discovery#60
Merged
Conversation
ShawnChen-Sirius
force-pushed
the
docs/agents-md-llms
branch
3 times, most recently
from
8ddcd29 to
68cbf0e
Compare
So coding agents and agentic IDEs pick chdb up correctly without guessing the API, with the per-task context cost kept small. - Root AGENTS.md (loaded into every task): direction only — what chdb is and its multi-source + Node-ingestion strengths, the entry-point decision tree, the Layer 2 vs Layer 3 disambiguation, and cross-cutting gotchas (64-bit precision, one-connection-per-path, streaming, typed errors, server-side binding). It points to the per-layer guides and the full reference instead of inlining them. - src/layer3/AGENTS.md: the fluent builder surface (verbs, dialect sugar, .stream(), terminals), connect() federation + URL schemes, and codegen. - src/connection/AGENTS.md: the @clickhouse/client compatibility facade — embedded-only contract, the eager-buffer gap, and the compat conventions. - llms-full.txt: the exhaustive flat API reference. All four ship via package.json "files". Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
ShawnChen-Sirius
force-pushed
the
docs/agents-md-llms
branch
from
68cbf0e to
d6b77bb
Compare
wudidapaopao
approved these changes
Jun 26, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds an in-package agent guide so coding agents and agentic IDEs pick chdb up
correctly without guessing the API, and ships both files in the npm package.
four entry points (raw SQL / fluent builder /
connect()federation /@clickhouse/clientcompat), minimal examples for each, an explicit Layer 2 vsLayer 3 disambiguation (do not route a fluent query through
chdb/connection),and the load-bearing gotchas (64-bit precision, one-connection-per-path,
streaming, typed errors, server-side binding).
method, ChdbResult, the three insert shapes and stream-insert failure taxonomy,
the fluent builder surface,
connect()URL schemes, type/format mapping, and theerror hierarchy.
Both are added to
package.jsonfilesso they ship to npm (npm packconfirmed).Docs only; no code or behavior change.
🤖 Generated with Claude Code