pgbulkhead 0.1.0__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.
@@ -0,0 +1,8 @@
1
+ .venv/
2
+ __pycache__/
3
+ *.pyc
4
+ .pytest_cache/
5
+ .ruff_cache/
6
+ dist/
7
+ build/
8
+ *.egg-info/
@@ -0,0 +1,25 @@
1
+ # Changelog
2
+
3
+ All notable changes to this project are recorded here. The format follows
4
+ [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and versions follow
5
+ [Semantic Versioning](https://semver.org/). Until 1.0, a minor version may change the API.
6
+
7
+ ## [0.1.0] - 2026-11-11
8
+
9
+ First release.
10
+
11
+ - `TenancyModel`: a tenant column (the hard wall), an optional workspace column (the soft
12
+ wall), the settings namespace, and an opt-in `GucBypass` or `RoleBypass` across the workspace
13
+ wall only.
14
+ - `policy_sql` / `policy_statements`: forced row-level security policies, per command for a
15
+ model with a workspace (reads span the readable set, writes bind the active workspace) and a
16
+ single policy for a single-key model. Idempotent, and names are validated before they reach
17
+ DDL.
18
+ - `SecurityContext`, `context_from_claims`: the verified identity, failing closed on a missing
19
+ tenant or workspace.
20
+ - `scoped_session`, `system_session`, `transaction`, `bind_context`: transaction-local binding
21
+ with a cancel-safe exit.
22
+ - `SecuredDatabase`, `PoolSettings`, `WorkspaceLimiter`: per-workspace admission sized together
23
+ with the pool, with `Overloaded` refusals whose text a server can replace.
24
+
25
+ [0.1.0]: https://github.com/NimbleBrainInc/pgbulkhead/releases/tag/v0.1.0
@@ -0,0 +1,201 @@
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 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 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 those 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
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,4 @@
1
+ pgbulkhead
2
+ Copyright 2026 NimbleBrain, Inc.
3
+
4
+ This product includes software developed at NimbleBrain, Inc.
@@ -0,0 +1,285 @@
1
+ Metadata-Version: 2.5
2
+ Name: pgbulkhead
3
+ Version: 0.1.0
4
+ Summary: Tenant isolation for multi-tenant MCP servers on Postgres. One database, many tenants and workspaces: Postgres enforces the walls, and no agent can talk its way through them.
5
+ Project-URL: Homepage, https://github.com/NimbleBrainInc/pgbulkhead
6
+ Project-URL: Issues, https://github.com/NimbleBrainInc/pgbulkhead/issues
7
+ Project-URL: Changelog, https://github.com/NimbleBrainInc/pgbulkhead/blob/main/CHANGELOG.md
8
+ Author: NimbleBrain, Inc.
9
+ License-Expression: Apache-2.0
10
+ License-File: LICENSE
11
+ License-File: NOTICE
12
+ Keywords: asyncio,mcp,multi-tenant,postgres,row-level-security,sqlalchemy
13
+ Classifier: Development Status :: 3 - Alpha
14
+ Classifier: Framework :: AsyncIO
15
+ Classifier: Intended Audience :: Developers
16
+ Classifier: Operating System :: OS Independent
17
+ Classifier: Programming Language :: Python :: 3
18
+ Classifier: Programming Language :: Python :: 3.12
19
+ Classifier: Programming Language :: Python :: 3.13
20
+ Classifier: Topic :: Database
21
+ Classifier: Typing :: Typed
22
+ Requires-Python: >=3.12
23
+ Requires-Dist: anyio>=4.4
24
+ Requires-Dist: sqlalchemy[asyncio]>=2.0.36
25
+ Description-Content-Type: text/markdown
26
+
27
+ # pgbulkhead
28
+
29
+ Tenant isolation for multi-tenant MCP servers on Postgres. One database, many tenants and
30
+ workspaces: Postgres enforces the walls, and no agent can talk its way through them.
31
+
32
+ - **Identity no prompt can steer.** Tenant and workspace come only from a verified context
33
+ (a token your server checked, or headers a gateway set), never from tool arguments. Row-level
34
+ security does the filtering, so a query that forgets its `WHERE tenant_id = ...` still sees
35
+ only its own tenant.
36
+ - **Fair sharing under agent fan-out.** Calls are admitted per workspace before they take a
37
+ connection, so one agent loop firing fifty calls queues behind its own workspace's slots
38
+ instead of taking the pool from everyone else.
39
+ - **Cancel-safe sessions.** Host timeouts and dropped clients cancel calls mid-transaction. Each
40
+ session rolls back and returns its connection under a shield, so cancellations don't leak
41
+ connections.
42
+ - **Errors an agent can act on.** An overloaded call is refused before it runs anything, with a
43
+ message that says so, so the agent knows a retry is safe.
44
+
45
+ It is for Python MCP servers (FastMCP or any other, on async SQLAlchemy) that serve more than
46
+ one customer from one Postgres database. It needs nothing else.
47
+
48
+ **What it is not.** Not a Postgres extension: it renders ordinary row-level security policies
49
+ and sets ordinary settings. Not an ORM: you write your queries with SQLAlchemy as usual. Not for
50
+ Django or sync SQLAlchemy. Not for a database per tenant. Not proof against arbitrary SQL run as
51
+ your app role; see [the threat model](#threat-model).
52
+
53
+ ```sh
54
+ pip install pgbulkhead # or: uv add pgbulkhead
55
+ ```
56
+
57
+ Python 3.12+, SQLAlchemy 2 (asyncio), any async Postgres driver (tested with asyncpg), Postgres
58
+ 14+.
59
+
60
+ ## How it works
61
+
62
+ You describe your walls once, as a `TenancyModel`. A migration renders its policies onto each
63
+ table. Every request opens a session with its verified context bound, and Postgres filters every
64
+ row it reads or writes.
65
+
66
+ ```python
67
+ from pgbulkhead import TenancyModel, policy_statements
68
+
69
+ # tenant_id is the hard wall; workspace_id is a soft wall inside it.
70
+ MODEL = TenancyModel(namespace="notes")
71
+
72
+ # In an alembic migration, after creating the table:
73
+ for statement in policy_statements(MODEL, "note"):
74
+ op.execute(statement)
75
+ ```
76
+
77
+ That table now admits a row only when its `tenant_id` matches the session's tenant. Reads span
78
+ the workspaces the session may read; writes go to its active workspace only. A session that
79
+ bound nothing sees no rows and can write none.
80
+
81
+ At request time, build the context from what you verified and open a session:
82
+
83
+ ```python
84
+ from pgbulkhead import SecuredDatabase, SecurityContext, context_from_claims
85
+
86
+ db = SecuredDatabase(model=MODEL, url_env="NOTES_DATABASE_URL", prefix="NOTES")
87
+ db.check() # at startup: settings validated, so a bad value fails the deploy, not a call
88
+
89
+ @mcp.tool()
90
+ async def list_notes() -> list[dict]:
91
+ ctx = context_from_claims(verified_claims()) # from your auth layer, never from arguments
92
+ async with db.session(ctx) as conn:
93
+ rows = await conn.execute(select(note)) # only this tenant's readable workspaces
94
+ return [dict(r._mapping) for r in rows]
95
+ ```
96
+
97
+ `db.session` admits the call against its workspace's concurrency limit, checks out a connection,
98
+ binds the context inside a transaction, and commits or rolls back on the way out.
99
+
100
+ ## Threat model
101
+
102
+ **The guarantee.** Isolation holds against query bugs and against identity taken from untrusted
103
+ input. It does not hold against arbitrary SQL execution in the app role.
104
+
105
+ What that means in practice:
106
+
107
+ - **Query bugs.** A missing `WHERE`, a wrong join, an unscoped `UPDATE`: Postgres applies the
108
+ policy to every statement, so the mistake returns or touches only rows the session's context
109
+ allows.
110
+ - **Identity from untrusted input.** The context is built from a verified source, so text an
111
+ agent writes (tool arguments, a request body, anything a prompt can steer) cannot choose the
112
+ tenant. Never build a `SecurityContext` from tool arguments: the model writes them, and anyone
113
+ who can put text in front of the model can steer what it writes.
114
+ - **Arbitrary SQL in the app role: not covered.** The context lives in Postgres settings the
115
+ session sets with `set_config`. The app role can set any of them, `<namespace>.tenant_id`
116
+ included, so SQL that runs as the app role without going through your code (SQL injection, or
117
+ a tool that executes model-written SQL) can move its own session to another tenant.
118
+ `tests/test_isolation.py::test_arbitrary_sql_in_the_app_role_is_outside_the_guarantee`
119
+ demonstrates it. If you run model-written SQL, run it as a separate role with no access to
120
+ these tables, or give each tenant its own role or database.
121
+
122
+ What the guarantee rests on, all of which is yours to provision:
123
+
124
+ 1. **The app role is not a superuser and not `BYPASSRLS`.** Either one silently voids every
125
+ policy. Create it with `NOSUPERUSER NOBYPASSRLS`.
126
+ 2. **The app role does not own the tables**, or the policies are `FORCE`d. The rendered DDL
127
+ forces them, so the owner is bound too, but keep migrations and serving on separate roles
128
+ anyway.
129
+ 3. **Every table holding tenant data has the policy.** Row-level security is per table and does
130
+ not follow foreign keys, so a child table carries the tenant (and workspace) columns and its
131
+ own policy. A table without one is unprotected.
132
+ 4. **The context comes from a verified source.** Everything above is moot if the tenant is read
133
+ from a tool argument.
134
+
135
+ Settings are bound with `set_config(name, value, true)` inside a transaction, as bound
136
+ parameters, so they end with the transaction and a pooled connection never carries one request's
137
+ tenant into the next.
138
+
139
+ ## Policy shapes
140
+
141
+ **Per-command** (the default: a tenant column and a workspace column). Four policies, one per
142
+ command, because a single `FOR ALL` policy cannot keep a read grant from deleting: Postgres
143
+ never applies `WITH CHECK` to `DELETE`, and `USING` picks the rows an `UPDATE` or `DELETE` may
144
+ touch. Split, the read predicate governs `SELECT` only, and every write is bound to the active
145
+ workspace both on the row it selects and on the row it writes.
146
+
147
+ **Single-key** (`workspace_column=None`). One policy scoping reads and writes on the tenant
148
+ alone. Use it for a tenant-wide fact (an opt-out list, an audit log) that every workspace of the
149
+ tenant shares, or for a service whose only wall is one key:
150
+
151
+ ```python
152
+ LEDGER = TenancyModel(workspace_column=None, namespace="notes")
153
+ ORGS = TenancyModel(tenant_column="org_id", workspace_column=None, namespace="notes")
154
+ ```
155
+
156
+ **Mixing shapes fails closed.** Each policy reads only its own settings, and an unset setting
157
+ reads as NULL, so a session bound for one model matches no row of a table under another. Getting
158
+ it wrong returns nothing, never the wrong rows.
159
+
160
+ Re-rendering is idempotent: the DDL drops its own policy names (and, by default, the other
161
+ shape's) before creating them, so a migration can switch a table between shapes.
162
+
163
+ ## Crossing the workspace wall
164
+
165
+ Some jobs (a reconciler, a nightly sweep) must read every workspace of a tenant. A model can
166
+ allow that with a bypass. **It is off unless you set one, and no bypass crosses the tenant
167
+ wall.**
168
+
169
+ | Bypass | How a session takes it | Who can take it |
170
+ |---|---|---|
171
+ | `GucBypass()` | `system_session(engine, model, tenant_id)` sets `<namespace>.role = 'system'` | anything that can run SQL as the app role, so it has the same exposure as the tenant setting |
172
+ | `RoleBypass("reconciler")` | connect as a login role that is a member of `reconciler` | only that role; SQL running as the app role cannot take it |
173
+
174
+ Prefer `RoleBypass` when the privileged path should be out of the app role's reach. Never grant
175
+ the bypass role to the app role.
176
+
177
+ ```python
178
+ SWEEP = TenancyModel(namespace="notes", bypass=RoleBypass("notes_reconciler"))
179
+ # The job uses its own engine, logging in as a member of notes_reconciler, and binds a tenant:
180
+ async with scoped_session(job_engine, SWEEP, SecurityContext("tenant-a", "any")) as conn:
181
+ ... # every workspace of tenant-a, and nothing of any other tenant
182
+ ```
183
+
184
+ ## Admission and the pool
185
+
186
+ A server serving many workspaces from one pool sizes the pool and admits calls per workspace,
187
+ so a burst from one workspace waits for its own slots. Settings are read once from
188
+ `<PREFIX>_…`:
189
+
190
+ | Setting | Default | Meaning |
191
+ |---|---|---|
192
+ | `DB_POOL_SIZE` | 5 | connections the pool keeps open |
193
+ | `DB_POOL_MAX_OVERFLOW` | 5 | connections it may open past that under load |
194
+ | `DB_POOL_TIMEOUT_SECONDS` | 10 | how long a checkout waits; past it, `PoolExhausted` |
195
+ | `WORKSPACE_CONCURRENCY` | 2 | calls one workspace runs at once per process |
196
+ | `WORKSPACE_WAIT_SECONDS` | 15 | how long a call over that waits for a slot; past it, `WorkspaceBusy` |
197
+
198
+ A call holds at most two connections (its session, and one write committed apart from it), so
199
+ `2 × WORKSPACE_CONCURRENCY` must stay below `DB_POOL_SIZE + DB_POOL_MAX_OVERFLOW`, or one
200
+ workspace could hold every connection. `PoolSettings` refuses settings that break that, so call
201
+ `db.check()` at startup and a bad value fails the deploy rather than a user's call. A server
202
+ with more traffic passes its own `defaults=PoolSettings(...)`; the environment still overrides
203
+ them.
204
+
205
+ Admit a call's own session only (`db.session`). A second session it opens while holding a slot
206
+ (`db.unadmitted_session`) is not admitted, or a workspace whose every slot waits on a second
207
+ session would deadlock. To run several sessions in turn under one slot, use
208
+ `async with db.admitted(ctx) as slot:` and `slot.session()`. A checkout timeout in
209
+ `slot.session()` raises the pool's own `TimeoutError`, not `PoolExhausted`: an earlier session
210
+ under the slot may have committed, so the request is not safe to retry as a whole.
211
+
212
+ **Overload errors.** `WorkspaceBusy` and `PoolExhausted` are both `Overloaded`, and the call ran
213
+ nothing. Each carries `message` and `next_step` text you can return to the agent as they are;
214
+ map them onto your error surface as a rate limit. Replace the text per server:
215
+
216
+ ```python
217
+ from pgbulkhead import Overloaded, RefusalText, WorkspaceBusy
218
+
219
+ db = SecuredDatabase(
220
+ model=MODEL, url_env="NOTES_DATABASE_URL", prefix="NOTES",
221
+ refusals={
222
+ WorkspaceBusy: RefusalText("This notebook has too many requests running.", "Retry in a few seconds."),
223
+ Overloaded: RefusalText("The notes service is busy.", "Retry in a few seconds."),
224
+ },
225
+ )
226
+ ```
227
+
228
+ ## Cancellation
229
+
230
+ An MCP call runs under a cancel scope, and a cancelled scope raises again at every await inside
231
+ it, including the session's own rollback. Unshielded, SQLAlchemy then terminates the connection
232
+ instead of returning it, and every cancelled call costs the pool one. Each session here ends its
233
+ transaction and returns its connection inside a shielded scope bounded by
234
+ `CLEANUP_TIMEOUT_SECONDS` (10s) per step. Past the bound, a rollback is abandoned and the
235
+ connection discarded, and a commit raises `TimeoutError`, because its writes may or may not
236
+ have landed.
237
+
238
+ A query interrupted in flight is the one loss left: the driver discards that connection itself,
239
+ because its protocol state is unknown. Nothing stays checked out either way.
240
+ `tests/test_session_cancel.py` proves both against a real Postgres.
241
+
242
+ ## API
243
+
244
+ | Name | What it is |
245
+ |---|---|
246
+ | `TenancyModel` | the walls: tenant column, optional workspace column, settings namespace, bypass |
247
+ | `GucBypass`, `RoleBypass` | the two ways to let a session cross the workspace wall |
248
+ | `policy_sql`, `policy_statements` | a table's policy DDL, as one string or one statement each |
249
+ | `SecurityContext` | one request's verified tenant, workspace, read grants and scopes |
250
+ | `context_from_claims`, `ClaimNames` | a context from verified token claims, fail closed |
251
+ | `scoped_session` | a transaction with a context bound, refusing an empty identity |
252
+ | `system_session` | a transaction through a `GucBypass`, optionally bound to one tenant |
253
+ | `transaction`, `bind_context`, `check_context` | the shielded transaction alone, the binding alone, and the check `scoped_session` runs before it |
254
+ | `SecuredDatabase` | one server's model, engine, pool settings and limiter |
255
+ | `PoolSettings`, `create_pooled_engine` | pool and admission settings, validated together |
256
+ | `WorkspaceLimiter`, `admitted_session` | per-workspace admission, for a server not using `SecuredDatabase` |
257
+ | `Overloaded`, `WorkspaceBusy`, `PoolExhausted`, `RefusalText` | refusals, and replacement text |
258
+ | `pgbulkhead.testing.use_limiter` | run a database's sessions under a small limiter in tests |
259
+
260
+ ## Development
261
+
262
+ ```sh
263
+ docker run -d --rm -p 127.0.0.1:5432:5432 -e POSTGRES_HOST_AUTH_METHOD=trust postgres:16-alpine
264
+ make verify # ruff format check, ruff lint, ty, pytest
265
+ ```
266
+
267
+ The database suites need a disposable Postgres with a superuser at `PGBULKHEAD_TEST_URL`
268
+ (default `postgresql+asyncpg://postgres@127.0.0.1:5432/postgres`); they create and drop their
269
+ own roles and tables. Without one they skip locally and fail under CI.
270
+
271
+ ## Releasing
272
+
273
+ 1. In a pull request, set `version` in `pyproject.toml` and date its `CHANGELOG.md` entry.
274
+ 2. After it merges, tag the merge commit `v<version>` and push the tag.
275
+ 3. `release.yml` builds once, then waits for approval of the `pypi` environment. Download the
276
+ run's `dist` artifact (the exact files PyPI will receive), install the wheel in a clean
277
+ environment, and run the suite against it.
278
+ 4. A maintainer approves the deployment, and those files go to PyPI. A version can never be
279
+ uploaded twice, so step 3 is the last chance to catch a broken release.
280
+
281
+ Publishing uses trusted publishing (OIDC); there is no API token to rotate or leak.
282
+
283
+ ## License
284
+
285
+ Apache-2.0. See [LICENSE](LICENSE) and [NOTICE](NOTICE). Security reports: [SECURITY.md](SECURITY.md).