squackit 0.2.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (39) hide show
  1. squackit-0.2.1/.github/workflows/release.yml +89 -0
  2. squackit-0.2.1/.gitignore +11 -0
  3. squackit-0.2.1/.mcp.json +16 -0
  4. squackit-0.2.1/.readthedocs.yaml +16 -0
  5. squackit-0.2.1/.readthedocs.yml +16 -0
  6. squackit-0.2.1/CLAUDE.md +32 -0
  7. squackit-0.2.1/LICENSE +190 -0
  8. squackit-0.2.1/PKG-INFO +86 -0
  9. squackit-0.2.1/README.md +59 -0
  10. squackit-0.2.1/docs/architecture.md +103 -0
  11. squackit-0.2.1/docs/configuration.md +111 -0
  12. squackit-0.2.1/docs/index.md +61 -0
  13. squackit-0.2.1/docs/prompts.md +64 -0
  14. squackit-0.2.1/docs/quickstart.md +96 -0
  15. squackit-0.2.1/docs/resources.md +45 -0
  16. squackit-0.2.1/docs/superpowers/plans/2026-04-10-phase1-handoff.md +203 -0
  17. squackit-0.2.1/docs/superpowers/plans/2026-04-10-squawkit-extraction.md +1054 -0
  18. squackit-0.2.1/docs/superpowers/plans/2026-04-11-phase3-pluckit-rewire.md +679 -0
  19. squackit-0.2.1/docs/superpowers/specs/2026-04-10-squawkit-design.md +258 -0
  20. squackit-0.2.1/docs/tools.md +249 -0
  21. squackit-0.2.1/mkdocs.yml +84 -0
  22. squackit-0.2.1/pyproject.toml +55 -0
  23. squackit-0.2.1/squackit/__init__.py +3 -0
  24. squackit-0.2.1/squackit/__main__.py +5 -0
  25. squackit-0.2.1/squackit/db.py +17 -0
  26. squackit-0.2.1/squackit/defaults.py +225 -0
  27. squackit-0.2.1/squackit/formatting.py +89 -0
  28. squackit-0.2.1/squackit/prompts.py +236 -0
  29. squackit-0.2.1/squackit/server.py +506 -0
  30. squackit-0.2.1/squackit/session.py +165 -0
  31. squackit-0.2.1/squackit/workflows.py +407 -0
  32. squackit-0.2.1/tests/conftest.py +115 -0
  33. squackit-0.2.1/tests/test_defaults.py +308 -0
  34. squackit-0.2.1/tests/test_prompts.py +239 -0
  35. squackit-0.2.1/tests/test_resources.py +190 -0
  36. squackit-0.2.1/tests/test_session.py +360 -0
  37. squackit-0.2.1/tests/test_smoke.py +31 -0
  38. squackit-0.2.1/tests/test_truncation.py +299 -0
  39. squackit-0.2.1/tests/test_workflows.py +302 -0
@@ -0,0 +1,89 @@
1
+ name: Release
2
+
3
+ on:
4
+ push:
5
+ tags:
6
+ - "v*"
7
+
8
+ concurrency:
9
+ group: release
10
+ cancel-in-progress: false
11
+
12
+ jobs:
13
+ build:
14
+ name: Build distributions
15
+ runs-on: ubuntu-latest
16
+ steps:
17
+ - uses: actions/checkout@v4
18
+ with:
19
+ fetch-depth: 0
20
+ - uses: actions/setup-python@v5
21
+ with:
22
+ python-version: "3.12"
23
+ - name: Install build
24
+ run: |
25
+ python -m pip install --upgrade pip
26
+ python -m pip install build
27
+ - name: Build wheel and sdist
28
+ run: python -m build
29
+ - name: Check distribution metadata
30
+ run: |
31
+ python -m pip install twine
32
+ python -m twine check dist/*
33
+ - name: Upload distributions
34
+ uses: actions/upload-artifact@v4
35
+ with:
36
+ name: dist
37
+ path: dist/
38
+ retention-days: 14
39
+
40
+ publish-pypi:
41
+ name: Publish to PyPI
42
+ runs-on: ubuntu-latest
43
+ needs: build
44
+ environment:
45
+ name: pypi
46
+ url: https://pypi.org/project/squawkit/
47
+ permissions:
48
+ id-token: write
49
+ steps:
50
+ - name: Download built distributions
51
+ uses: actions/download-artifact@v4
52
+ with:
53
+ name: dist
54
+ path: dist/
55
+ - name: Publish to PyPI
56
+ uses: pypa/gh-action-pypi-publish@release/v1
57
+
58
+ github-release:
59
+ name: Create GitHub Release
60
+ runs-on: ubuntu-latest
61
+ needs: publish-pypi
62
+ permissions:
63
+ contents: write
64
+ env:
65
+ TAG_NAME: ${{ github.ref_name }}
66
+ GH_REPO: ${{ github.repository }}
67
+ GH_TOKEN: ${{ github.token }}
68
+ steps:
69
+ - uses: actions/checkout@v4
70
+ with:
71
+ fetch-depth: 0
72
+ - name: Download built distributions
73
+ uses: actions/download-artifact@v4
74
+ with:
75
+ name: dist
76
+ path: dist/
77
+ - name: Create GitHub Release
78
+ run: |
79
+ set -euo pipefail
80
+ PRERELEASE_FLAG=""
81
+ case "$TAG_NAME" in
82
+ *a[0-9]*|*b[0-9]*|*rc[0-9]*) PRERELEASE_FLAG="--prerelease" ;;
83
+ esac
84
+ gh release create "$TAG_NAME" \
85
+ --repo "$GH_REPO" \
86
+ --title "$TAG_NAME" \
87
+ --notes "See commit history for changes." \
88
+ $PRERELEASE_FLAG \
89
+ dist/*
@@ -0,0 +1,11 @@
1
+ __pycache__/
2
+ *.py[cod]
3
+ *.so
4
+ .pytest_cache/
5
+ .venv/
6
+ venv/
7
+ dist/
8
+ build/
9
+ *.egg-info/
10
+ .DS_Store
11
+ .squawkit/
@@ -0,0 +1,16 @@
1
+ {
2
+ "mcpServers": {
3
+ "squawkit": {
4
+ "command": "/home/teague/.local/share/venv/bin/squawkit",
5
+ "args": []
6
+ },
7
+ "blq": {
8
+ "command": "/home/teague/.local/share/venv/bin/blq",
9
+ "args": ["mcp", "serve"]
10
+ },
11
+ "jetsam": {
12
+ "command": "/home/teague/.local/share/venv/bin/jetsam",
13
+ "args": ["serve"]
14
+ }
15
+ }
16
+ }
@@ -0,0 +1,16 @@
1
+ version: 2
2
+
3
+ build:
4
+ os: ubuntu-22.04
5
+ tools:
6
+ python: "3.12"
7
+
8
+ mkdocs:
9
+ configuration: mkdocs.yml
10
+
11
+ python:
12
+ install:
13
+ - method: pip
14
+ path: .
15
+ extra_requirements:
16
+ - docs
@@ -0,0 +1,16 @@
1
+ version: 2
2
+
3
+ build:
4
+ os: ubuntu-22.04
5
+ tools:
6
+ python: "3.12"
7
+
8
+ mkdocs:
9
+ configuration: mkdocs.yml
10
+
11
+ python:
12
+ install:
13
+ - method: pip
14
+ path: .
15
+ extra_requirements:
16
+ - docs
@@ -0,0 +1,32 @@
1
+ # squackit: Project Conventions
2
+
3
+ ## Current state (post-Phase 3)
4
+
5
+ squackit reaches fledgling's SQL macros only through pluckit. The
6
+ dependency chain invariant is enforced:
7
+
8
+ squackit → pluckit → fledgling-python → fledgling (SQL)
9
+
10
+ ## Import rules
11
+
12
+ - `squackit.*` for internal imports
13
+ - `pluckit.*` for the fluent API and the macro-enabled Connection
14
+ (squackit's only runtime dependency for fledgling access)
15
+ - **Never** `import fledgling` or `from fledgling_python ...`. If you
16
+ need a capability pluckit doesn't expose, grow pluckit — don't add an
17
+ escape hatch.
18
+ - Tests use `from conftest import PROJECT_ROOT` — squackit's `conftest.py`
19
+ defines `PROJECT_ROOT` lazily via fledgling package discovery (repo
20
+ layout preferred, bundled-package layout as fallback).
21
+
22
+ ## Tests
23
+
24
+ Run with:
25
+ ```
26
+ FLEDGLING_REPO_PATH=/path/to/fledgling/repo pytest tests/
27
+ ```
28
+
29
+ Tests dog-food against the fledgling repo. Set `FLEDGLING_REPO_PATH` to
30
+ the repo root, or let conftest auto-discover from the installed fledgling
31
+ package (covers most tests; 6 tests that reference repo-only paths like
32
+ `docs/vision/*.md` still need the env var).
squackit-0.2.1/LICENSE ADDED
@@ -0,0 +1,190 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to the Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by the Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding any notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ Copyright 2026 Teague Sterling
179
+
180
+ Licensed under the Apache License, Version 2.0 (the "License");
181
+ you may not use this file except in compliance with the License.
182
+ You may obtain a copy of the License at
183
+
184
+ http://www.apache.org/licenses/LICENSE-2.0
185
+
186
+ Unless required by applicable law or agreed to in writing, software
187
+ distributed under the License is distributed on an "AS IS" BASIS,
188
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
189
+ See the License for the specific language governing permissions and
190
+ limitations under the License.
@@ -0,0 +1,86 @@
1
+ Metadata-Version: 2.4
2
+ Name: squackit
3
+ Version: 0.2.1
4
+ Summary: Semi-QUalified Agent Companion Kit — the stateful intelligence + MCP server layer for fledgling-equipped agents.
5
+ Project-URL: Homepage, https://github.com/teaguesterling/squackit
6
+ Project-URL: Documentation, https://squackit.readthedocs.io
7
+ Project-URL: Repository, https://github.com/teaguesterling/squackit
8
+ Project-URL: Issues, https://github.com/teaguesterling/squackit/issues
9
+ Author: Teague Sterling
10
+ License-Expression: Apache-2.0
11
+ License-File: LICENSE
12
+ Keywords: ai-agents,code-intelligence,duckdb,fledgling,mcp
13
+ Classifier: Development Status :: 3 - Alpha
14
+ Classifier: Intended Audience :: Developers
15
+ Classifier: License :: OSI Approved :: Apache Software License
16
+ Classifier: Programming Language :: Python :: 3
17
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
18
+ Requires-Python: >=3.9
19
+ Requires-Dist: ast-pluckit>=0.7.0
20
+ Requires-Dist: fastmcp>=3.0
21
+ Provides-Extra: docs
22
+ Requires-Dist: mkdocs-exclude>=1.0; extra == 'docs'
23
+ Requires-Dist: mkdocs-material>=9.5; extra == 'docs'
24
+ Requires-Dist: mkdocs>=1.6; extra == 'docs'
25
+ Requires-Dist: pymdown-extensions>=10.9; extra == 'docs'
26
+ Description-Content-Type: text/markdown
27
+
28
+ # squackit
29
+
30
+ [![PyPI](https://img.shields.io/pypi/v/squackit)](https://pypi.org/project/squackit/)
31
+ [![Docs](https://readthedocs.org/projects/squackit/badge/?version=latest)](https://squackit.readthedocs.io/)
32
+ [![License](https://img.shields.io/badge/license-Apache--2.0-blue)](LICENSE)
33
+
34
+ **Semi-QUalified Agent Companion Kit.** The stateful intelligence + MCP server
35
+ layer for [fledgling](https://github.com/teaguesterling/fledgling)-equipped
36
+ agents.
37
+
38
+ squackit wraps fledgling's SQL macros (via
39
+ [pluckit](https://github.com/teaguesterling/pluckit) — `pip install ast-pluckit`) with smart defaults,
40
+ token-aware output, session caching, compound workflows, an MCP server,
41
+ prompt templates, and live resources.
42
+
43
+ ## Install
44
+
45
+ ```bash
46
+ pip install squackit
47
+ ```
48
+
49
+ ## Run
50
+
51
+ ```bash
52
+ squackit
53
+ ```
54
+
55
+ Starts the FastMCP server on stdio. Connect it to Claude Code, Cursor, or any
56
+ MCP-compatible client.
57
+
58
+ ## What agents get
59
+
60
+ - **25+ tools** — code search, AST analysis, doc browsing, git history, diagnostics
61
+ - **4 compound workflows** — `explore`, `investigate`, `review`, `search`
62
+ - **3 prompt templates** — pre-loaded with live project data
63
+ - **5 resources** — always-on project overview, docs, git status, session log
64
+ - **Smart defaults** — infers language, doc layout, main branch automatically
65
+ - **Token-aware output** — truncation with head+tail hints, automatic bypass
66
+
67
+ ## Architecture
68
+
69
+ ```
70
+ squackit → ast-pluckit → fledgling-python → fledgling (SQL) → DuckDB extensions
71
+ ```
72
+
73
+ > **Note:** pluckit is published on PyPI as
74
+ > [`ast-pluckit`](https://pypi.org/project/ast-pluckit/). The Python import
75
+ > name is still `pluckit`.
76
+
77
+ squackit is the opinionated top layer. It adds session state, MCP protocol,
78
+ and intelligence heuristics on top of the stateless query layers below it.
79
+
80
+ ## Documentation
81
+
82
+ Full docs at **[squackit.readthedocs.io](https://squackit.readthedocs.io/)**.
83
+
84
+ ## License
85
+
86
+ Apache 2.0
@@ -0,0 +1,59 @@
1
+ # squackit
2
+
3
+ [![PyPI](https://img.shields.io/pypi/v/squackit)](https://pypi.org/project/squackit/)
4
+ [![Docs](https://readthedocs.org/projects/squackit/badge/?version=latest)](https://squackit.readthedocs.io/)
5
+ [![License](https://img.shields.io/badge/license-Apache--2.0-blue)](LICENSE)
6
+
7
+ **Semi-QUalified Agent Companion Kit.** The stateful intelligence + MCP server
8
+ layer for [fledgling](https://github.com/teaguesterling/fledgling)-equipped
9
+ agents.
10
+
11
+ squackit wraps fledgling's SQL macros (via
12
+ [pluckit](https://github.com/teaguesterling/pluckit) — `pip install ast-pluckit`) with smart defaults,
13
+ token-aware output, session caching, compound workflows, an MCP server,
14
+ prompt templates, and live resources.
15
+
16
+ ## Install
17
+
18
+ ```bash
19
+ pip install squackit
20
+ ```
21
+
22
+ ## Run
23
+
24
+ ```bash
25
+ squackit
26
+ ```
27
+
28
+ Starts the FastMCP server on stdio. Connect it to Claude Code, Cursor, or any
29
+ MCP-compatible client.
30
+
31
+ ## What agents get
32
+
33
+ - **25+ tools** — code search, AST analysis, doc browsing, git history, diagnostics
34
+ - **4 compound workflows** — `explore`, `investigate`, `review`, `search`
35
+ - **3 prompt templates** — pre-loaded with live project data
36
+ - **5 resources** — always-on project overview, docs, git status, session log
37
+ - **Smart defaults** — infers language, doc layout, main branch automatically
38
+ - **Token-aware output** — truncation with head+tail hints, automatic bypass
39
+
40
+ ## Architecture
41
+
42
+ ```
43
+ squackit → ast-pluckit → fledgling-python → fledgling (SQL) → DuckDB extensions
44
+ ```
45
+
46
+ > **Note:** pluckit is published on PyPI as
47
+ > [`ast-pluckit`](https://pypi.org/project/ast-pluckit/). The Python import
48
+ > name is still `pluckit`.
49
+
50
+ squackit is the opinionated top layer. It adds session state, MCP protocol,
51
+ and intelligence heuristics on top of the stateless query layers below it.
52
+
53
+ ## Documentation
54
+
55
+ Full docs at **[squackit.readthedocs.io](https://squackit.readthedocs.io/)**.
56
+
57
+ ## License
58
+
59
+ Apache 2.0
@@ -0,0 +1,103 @@
1
+ # Architecture
2
+
3
+ ## Layering
4
+
5
+ squackit sits at the top of the fledgling stack, adding stateful intelligence
6
+ on top of the stateless query layers below it.
7
+
8
+ ```
9
+ Layer 4 Consumers (Claude Code, agents, IDE extensions)
10
+
11
+ Layer 3b squackit ─── stateful MCP server + intelligence
12
+ │ smart defaults, caching, truncation,
13
+ │ workflows, prompts, resources
14
+
15
+ Layer 3a pluckit ──── fluent Python API (jQuery-like, stateless)
16
+ │ CSS selectors over ASTs, chainable queries
17
+
18
+ Layer 2 fledgling-python ── thin Python bundler
19
+ │ connect(), attach(), configure()
20
+
21
+ Layer 1 fledgling ──── SQL macros (language-agnostic)
22
+ │ find_definitions, code_structure,
23
+ │ doc_outline, recent_changes, ...
24
+
25
+ Layer 0 DuckDB extensions
26
+ sitting_duck (AST parsing)
27
+ markdown (doc parsing)
28
+ duck_tails (git integration)
29
+ read_lines (file I/O)
30
+ ```
31
+
32
+ ## Dependency invariants
33
+
34
+ These are enforced at the package level, not just by convention:
35
+
36
+ 1. **squackit imports pluckit, never fledgling-python.** If squackit needs
37
+ a capability pluckit doesn't expose, pluckit grows the capability.
38
+
39
+ 2. **squackit never constructs SQL strings.** It calls tools via the
40
+ fledgling Connection proxy that pluckit provides, which auto-generates
41
+ Python wrappers for every published SQL macro.
42
+
43
+ 3. **squackit is the only layer with session state.** Pluckit holds no
44
+ per-call memory. Fledgling-python holds no per-call memory.
45
+
46
+ 4. **squackit is the only layer that knows about MCP.** FastMCP wiring,
47
+ prompt templates, and resource handlers live exclusively in squackit.
48
+
49
+ ## Module responsibilities
50
+
51
+ | Module | Role |
52
+ |--------|------|
53
+ | `server.py` | FastMCP server wiring. Auto-registers fledgling macros as MCP tools, defines resources, connects prompts and workflows. The main entry point. |
54
+ | `defaults.py` | Project inference. Analyzes the codebase at startup to determine `code_pattern`, `doc_pattern`, `main_branch`. Reads config file overrides. |
55
+ | `formatting.py` | Token-aware truncation. Head+tail display, omission messages, bypass logic for narrowing parameters. |
56
+ | `workflows.py` | Compound workflow tools. `explore`, `investigate`, `review`, `search` — each composes multiple fledgling macros into a single briefing. |
57
+ | `session.py` | Session state. `SessionCache` (in-memory with TTL) and `AccessLog` (records every tool call). |
58
+ | `prompts.py` | MCP prompt templates. `explore`, `investigate`, `review` — pre-load live data into structured workflow instructions. |
59
+ | `db.py` | Connection factory. Thin wrapper over `pluckit.Plucker(...).connection` that returns a fledgling-enabled Connection proxy. |
60
+
61
+ ## How a tool call flows
62
+
63
+ ```
64
+ Agent calls "find_definitions" via MCP
65
+
66
+
67
+ server.py: _register_tool handler
68
+
69
+ ├─ Apply smart defaults (defaults.py)
70
+ │ file_pattern = agent's value or inferred code_pattern
71
+
72
+ ├─ Check session cache (session.py)
73
+ │ Cache hit → return cached result with "(cached)" note
74
+
75
+ ├─ Execute macro via Connection proxy
76
+ │ con.find_definitions(file_pattern=..., name_pattern=...)
77
+ │ │
78
+ │ ▼
79
+ │ pluckit → fledgling-python → DuckDB → sitting_duck
80
+
81
+ ├─ Format result (formatting.py)
82
+ │ Truncate if over limit, add head+tail hints
83
+
84
+ ├─ Update cache and access log (session.py)
85
+
86
+ └─ Return formatted text to agent
87
+ ```
88
+
89
+ ## What squackit is NOT
90
+
91
+ - **Not a code editor.** squackit reads and analyzes code; it doesn't
92
+ modify it. Write operations belong to the agent or IDE.
93
+
94
+ - **Not an LLM.** squackit provides structured data to agents; the
95
+ intelligence is in the agent that consumes the tools.
96
+
97
+ - **Not a generic MCP framework.** squackit is specifically about
98
+ fledgling's code intelligence macros. For generic MCP servers, use
99
+ [FastMCP](https://github.com/jlowin/fastmcp) directly.
100
+
101
+ - **Not pluckit.** pluckit is a stateless fluent API for developers.
102
+ squackit is a stateful MCP server for agents. They share the same
103
+ SQL backbone but serve different audiences with different needs.