docs: gateway-first README + split engine internals into engine/README#23
Open
JinBa1 wants to merge 1 commit into
Open
docs: gateway-first README + split engine internals into engine/README#23JinBa1 wants to merge 1 commit into
JinBa1 wants to merge 1 commit into
Conversation
…als into engine/README The root README led with "an in-memory relational query engine" and listed only engine SQL features — the REST + MCP gateway was invisible. Reframe it around what the project now is: a self-hosted, read-only, budgeted SQL gateway that AI agents reach over REST and MCP. - root README: gateway-first and punchy — tagline + why, a capability matrix (gateway + engine), a container-first quick start, the five MCP tools, the REST surface with fail-closed budget semantics (429/504), a real EXPLAIN example, and a short "how it works" (the QueryService choke point). Links to the engine README. - engine/README.md (new): the deep engine internals relocated here — architecture, scope, CLI usage + demo, total-work budgets, full EXPLAIN, join algorithms, the JMH benchmark table, and the sample-query runner. - accuracy pass: EXPLAIN examples regenerated from real CLI output (the planner auto-selects HashJoin for equi-joins; the old plan showed a plain Join); test counts corrected to engine 419 + server 90; file counts refreshed. Docs only — no code change.
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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.
The root README led with "an in-memory relational query engine" and listed only engine SQL features — the REST + MCP gateway was invisible. This reframes it around what the project now is: a self-hosted, read-only, budgeted SQL gateway that AI agents reach over REST and MCP.
Changes
README.md— gateway-first and punchy: tagline + why, a capability matrix (gateway + engine), a container-first quick start (docker run -v <csvs>:/cuckoodb/data … ghcr.io/jinba1/cuckoodb), the five MCP tools, the REST surface with fail-closed budget semantics (429/504), a realEXPLAINexample, and a short "how it works" (theQueryServicechoke point). ~870 words.engine/README.md(new): the deep engine internals relocated here — architecture, scope, CLI usage + demo, total-work budgets, fullEXPLAIN, join algorithms, the JMH benchmark table, the sample-query runner, and the engine layout.Accuracy pass
EXPLAINexamples regenerated from real CLI output — the planner auto-selectsHashJoinfor equi-joins; the old README showed a plainJoin, which was stale.docker runquick start works (/tables,/queries,/mcp).Docs only — no code change.