Repository navigation
docs: close the five review findings left on the A2ML exit (#383) #384
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -100,6 +100,7 @@ Gateway sidecar (`http-capability-gateway` in front of boj-server): | |
| * [x] Implement `PolicyLoader.load_from_boj_catalog/1` in `http-capability-gateway` — reads `BOJ_CARTRIDGES_ROOT/*/cartridge.json` at boot, infers per-cartridge invoke exposure from `auth.method` (`none` → `public`, others → `authenticated`). Zero manual policy maintenance thereafter. See `docs/gateway-catalog-integration.adoc`. | ||
| * [x] Update `compose.dev.yaml` with gateway sidecar entry (port 7800 → boj-rest:7700) | ||
| * [x] Retire static `gateway-policy.yaml` — catalog mode live 2026-04-25; file kept as reference only | ||
| * [ ] Tier-2 gateway status: `PENDING — http-capability-gateway wiring forthcoming`. Production rollout under `standards#100` per `docs/integration/hcg-tier2-rollout-runbook.adoc`, whose §6.4 flips this item to `DEPLOYED` (with `deployed_at` and the evidence links) as its last action, and whose §5.3 sets it to `DISABLED` on a permanent disable. This status was `[CLOUDFLARE_EDGE_SECURITY].rate_limiting.tier_2_gateway.status` in the Trustfile retired on 2026-11-14 (`docs/history/A2ML-REMOVED.adoc`); it moves to `Trustfile.deed` when that is written. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
When a gateway version is permanently disabled before the final §6.4 flip—such as during the rollout or seven-day soak—§5.3 explicitly leaves this item at Useful? React with 👍 / 👎. |
||
|
|
||
| == Future Directions | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -205,23 +205,53 @@ The third axis allows community extensions to specialise a cartridge for a speci | |
|
|
||
| === Write an extension descriptor | ||
|
|
||
| Write the descriptor as a cartridge manifest (currently `cartridge.json`); see | ||
| link:../EXTENSIBILITY.adoc[EXTENSIBILITY] §1 for the format. The fields are: | ||
| Write the descriptor as a cartridge manifest, `cartridge.json`, valid against | ||
| `schemas/cartridge-v1.json` (the mirror `BojRest.Catalog` validates every | ||
| manifest against at boot; a manifest that fails is rejected). A minimal | ||
| manifest: | ||
|
|
||
| [source,toml] | ||
| [source,json] | ||
| ---- | ||
| [extension] | ||
| name = "database-mcp-pg" | ||
| domain = "database" | ||
| backend = "postgresql" | ||
| tier = "ayo" | ||
| protocols = ["mcp", "rest"] | ||
|
|
||
| [metadata] | ||
| author = "Your Name <you@example.com>" | ||
| description = "PostgreSQL-native database cartridge" | ||
| { | ||
| "$schema": "https://hyperpolymath.dev/standards/cartridges/cartridge-v1.json", | ||
| "spdx": "MPL-2.0", | ||
| "copyright": "Copyright (c) 2026 Your Name <you@example.com>", | ||
| "name": "database-pg-mcp", | ||
| "version": "0.1.0", | ||
| "description": "PostgreSQL-native database cartridge", | ||
| "domain": "database", | ||
| "category": "domain", | ||
| "tier": "Ayo", | ||
| "protocols": ["MCP", "REST"], | ||
| "auth": { | ||
| "method": "none", | ||
| "env_var": null, | ||
| "credential_source": null | ||
| }, | ||
| "api": { | ||
| "base_url": "local://database-pg-mcp", | ||
| "content_type": "application/json" | ||
| }, | ||
| "tools": [ | ||
| { | ||
| "name": "pg_query", | ||
| "description": "Run a read-only SQL query", | ||
| "inputSchema": { | ||
| "type": "object", | ||
| "properties": { "sql": { "type": "string" } }, | ||
| "required": ["sql"] | ||
| } | ||
| } | ||
| ] | ||
| } | ||
|
Comment on lines
+245
to
+246
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
When a developer installs this manifest and follows the next section to build a shared library, the missing top-level Useful? React with 👍 / 👎. |
||
| ---- | ||
|
|
||
| The schema requires the role suffix last in `name` (`-mcp`, `-lsp`, ...), so | ||
| a PostgreSQL specialisation of `database-mcp` is named `database-pg-mcp`. | ||
| Community extensions are `Ayo` tier. The schema has no `backend` field, so the | ||
| backend label (third axis) is set through the FFI | ||
| (`boj_catalogue_set_backend`, link:../EXTENSIBILITY.adoc[EXTENSIBILITY] §4). | ||
|
|
||
| === Build a shared library | ||
|
|
||
| Export the BoJ cartridge invoke contract: | ||
|
|
@@ -239,14 +269,14 @@ int boj_ext_invoke(const char* tool, const char* params_json, | |
| curl -X POST http://localhost:7700/community/submit \ | ||
| -H 'Content-Type: application/json' \ | ||
| -d '{ | ||
| "name": "database-mcp-pg", | ||
| "name": "database-pg-mcp", | ||
| "author": "Your Name <you@example.com>", | ||
| "description": "PostgreSQL-native database cartridge", | ||
| "hash": "a1b2c3...64-char-sha256" | ||
| }' | ||
| ---- | ||
|
|
||
| See link:../EXTENSIBILITY.md[`docs/EXTENSIBILITY.adoc`] for the full guide. | ||
| See link:../EXTENSIBILITY.adoc[`docs/EXTENSIBILITY.adoc`] for the full guide. | ||
|
|
||
| == Running Tests | ||
|
|
||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
At session startup this document requires agents to read
boj-server_chora.deed, but that deed'simplementation-policyallows JavaScript only as Deno and expressly forbids npm, while these new lines require Bun first and permit npm as a fallback. An agent following both mandatory sources therefore has no consistent policy for Bun/npm changes; synchronize the deed with this policy or retain the existing restrictions here until the canonical source is updated.Useful? React with 👍 / 👎.