apcore-mcp 0.13.0 → 0.15.0

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2024 AI Perceivable
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -12,6 +12,8 @@ Converts apcore module registries into [Model Context Protocol (MCP)](https://mo
 
 - **MCP Server** — Expose apcore modules as MCP tools over stdio, Streamable HTTP, or SSE
 - **OpenAI Tools** — Convert modules to OpenAI function calling format with strict mode support
+- **Markdown tool descriptions** (`richDescription: true`, v0.15+) — render `Tool.description` and OpenAI `function.description` as canonical apcore-toolkit Markdown so LLMs get more decision-relevant signal per token. Requires `apcore-toolkit` (declared as `optionalDependencies`) and `await MCPServerFactory.prepare()` at startup.
+- **Module preview meta-tool** (`__apcore_module_preview`, v0.15+) — drives `executor.validate()` to predict state changes WITHOUT executing the module (apcore PROTOCOL_SPEC §5.6). Returns `{valid, requires_approval, predicted_changes, checks}` so AI orchestrators can ask "what would change?" before invoking.
 - **Schema Conversion** — Inline `$defs`/`$ref` from Pydantic-generated JSON Schema
 - **Annotation Mapping** — Map module annotations to MCP hints and OpenAI description suffixes
 - **Approval Mechanism** — Built-in elicitation-based approval flow for sensitive tool executions
@@ -30,7 +32,8 @@ For full documentation, including Quick Start guides for both Python and TypeScr
 ## Requirements
 
 - Node.js >= 18.0.0
-- `apcore-js >= 0.17.1`
+- `apcore-js >= 0.21.1`
+- Optional: `apcore-toolkit >= 0.6.1` for Markdown-rendered tool descriptions (declared under `optionalDependencies`).
 
 ## Installation
 
@@ -96,8 +99,10 @@ npx apcore-mcp --extensions-dir ./extensions --transport sse --port 8000
 | `--jwt-algorithm` | `HS256` | JWT algorithm |
 | `--jwt-audience` | — | Expected JWT audience claim |
 | `--jwt-issuer` | — | Expected JWT issuer claim |
-| `--jwt-require-auth` | `true` | Require auth (use `--no-jwt-require-auth` for permissive mode) |
-| `--exempt-paths` | `/health,/metrics` | Comma-separated paths exempt from auth |
+| `--jwt-require-auth` | `true` | Require auth (use `--jwt-permissive` to override and allow unauthenticated requests) |
+| `--jwt-permissive` | `false` | Permissive mode: allow unauthenticated requests (overrides `--jwt-require-auth`) |
+| `--exempt-paths` | `/health,/metrics,/usage` | Comma-separated paths exempt from auth |
+| `--output-format` | `json` | Built-in output format: `json`, `csv`, or `jsonl` |
 
 JWT key resolution priority: `--jwt-key-file` > `--jwt-secret` > `APCORE_JWT_SECRET` environment variable.
 
@@ -161,6 +166,79 @@ Connect any MCP client to `http://your-host:9000/mcp`.
 
 ## API Reference
 
+### Programmatic API – `APCoreMCP` class
+
+The `APCoreMCP` class is the recommended OOP entry point. It bundles a unified configuration object, lazy backend resolution (path / `Registry` / `Executor`), and exposes `serve` / `asyncServe` / `toOpenaiTools` as instance methods so you configure once and use everywhere.
+
+```typescript
+import { APCoreMCP } from "apcore-mcp";
+
+// 1. Point at an extensions directory (lazy discovery on first use)
+const mcp = new APCoreMCP("./extensions", {
+  name: "my-server",
+  tags: ["public"],
+  observability: true,
+});
+
+// 2. Launch as MCP server (blocks until shutdown)
+await mcp.serve({ transport: "streamable-http", port: 8000, explorer: true });
+
+// 3. Or export OpenAI tool definitions
+const tools = mcp.toOpenaiTools({ strict: true });
+
+// 4. Or embed into an existing HTTP server
+const app = await mcp.asyncServe({ explorer: true });
+// app.handler is a Node.js request handler; call app.close() on shutdown
+
+// 5. Or pass an existing Registry / Executor
+import { Registry } from "apcore-js";
+const registry = new Registry({ extensionsDir: "./extensions" });
+await registry.discover();
+const mcp2 = new APCoreMCP(registry, { name: "my-server", tags: ["public"] });
+```
+
+**Constructor**
+
+```typescript
+new APCoreMCP(
+  extensionsDirOrBackend: string | Registry | Executor,
+  options?: APCoreMCPOptions,
+);
+```
+
+The first argument is either a path to an apcore extensions directory (discovery is deferred to first use) or an existing `Registry` / `Executor` instance.
+
+**`APCoreMCPOptions` fields**
+
+- `name` — MCP server name. Default: `"apcore-mcp"`
+- `version` — MCP server version. Default: package version
+- `tags` — Filter modules by tag list
+- `prefix` — Filter modules by ID prefix
+- `logLevel` — Minimum log level (`DEBUG` | `INFO` | `WARNING` | `ERROR` | `CRITICAL`)
+- `validateInputs` — Validate inputs against schemas. Default: `false`
+- `metricsCollector` — `MetricsExporter` or `true` to auto-instantiate
+- `observability` — Enable the full metrics + usage observability stack
+- `async` — `boolean | { enabled?, maxConcurrent?, maxTasks? }` for the Async Task Bridge (F-043)
+- `authenticator` — Optional `Authenticator` (HTTP transports only)
+- `requireAuth` — If `true` (default), reject unauthenticated requests with 401
+- `exemptPaths` — Paths exempt from authentication
+- `approvalHandler` — Optional approval handler passed to the Executor
+- `outputFormatter` — Custom function to format tool execution results
+- `middleware` — Array of apcore `Middleware` installed via `executor.use()`
+- `acl` — Optional apcore `ACL` instance installed via `executor.setAcl()`
+
+**Properties**
+
+- `.registry` — The underlying apcore `Registry` (resolved on first access)
+- `.executor` — The underlying apcore `Executor` (populated after `serve()` / `asyncServe()`)
+- `.tools` — List of discovered module IDs that will be exposed as tools (honours `tags` / `prefix`)
+
+**Methods**
+
+- `.serve(options?)` — Launch an MCP server. Accepts `APCoreMCPServeOptions`: `transport`, `host`, `port`, `onStartup`, `onShutdown`, `explorer`, `explorerPrefix`, `allowExecute`, `explorerTitle`, `explorerProjectName`, `explorerProjectUrl`. Constructor-level options (auth, observability, middleware, acl, async, etc.) are applied automatically.
+- `.asyncServe(options?)` — Build an embeddable Node.js HTTP request handler. Accepts `APCoreMCPAsyncServeOptions`: `explorer`, `explorerPrefix`, `allowExecute`, `explorerTitle`, `explorerProjectName`, `explorerProjectUrl`, `endpoint`. Returns `{ handler, close }`.
+- `.toOpenaiTools(options?)` — Export modules as OpenAI-compatible tool definitions. Accepts `ToOpenaiToolsOptions`: `embedAnnotations`, `strict`. `tags` / `prefix` are inherited from the constructor.
+
 ### `serve(registryOrExecutor, options?)`
 
 Launch an MCP Server that exposes all apcore modules as tools.
@@ -169,41 +247,112 @@ Launch an MCP Server that exposes all apcore modules as tools.
 function serve(
   registryOrExecutor: Registry | Executor,
   options?: {
+    // Transport
     transport?: "stdio" | "streamable-http" | "sse";
     host?: string;
     port?: number;
+    // Identity
     name?: string;
     version?: string;
-    dynamic?: boolean;
-    validateInputs?: boolean;
+    // Lifecycle
+    onStartup?: () => void | Promise<void>;
+    onShutdown?: () => void | Promise<void>;
+    // Module filtering / discovery
     tags?: string[] | null;
     prefix?: string | null;
+    dynamic?: boolean;
+    validateInputs?: boolean;
     logLevel?: "DEBUG" | "INFO" | "WARNING" | "ERROR" | "CRITICAL";
-    onStartup?: () => void | Promise<void>;
-    onShutdown?: () => void | Promise<void>;
-    metricsCollector?: MetricsExporter;
+    // Async Task Bridge (F-043)
+    async?: boolean | { enabled?: boolean; maxConcurrent?: number; maxTasks?: number };
+    // Executor wiring
+    middleware?: unknown[];
+    acl?: unknown;
+    approvalHandler?: unknown;
+    strategy?: string;
+    // Observability (F-044)
+    metricsCollector?: MetricsExporter | boolean;
+    observability?: ObservabilityFlag;
+    trace?: boolean;
+    // Output handling
+    outputFormatter?: (result: Record<string, unknown>) => string;
+    redactOutput?: boolean;
+    // Auth (HTTP transports only)
+    authenticator?: Authenticator;
+    requireAuth?: boolean;
+    exemptPaths?: string[];
+    // Tool Explorer UI
     explorer?: boolean;
     explorerPrefix?: string;
     allowExecute?: boolean;
-    authenticator?: Authenticator;
-    exemptPaths?: string[];
-    approvalHandler?: unknown;
     explorerTitle?: string;
     explorerProjectName?: string;
     explorerProjectUrl?: string;
-    requireAuth?: boolean;
-    outputFormatter?: (result: Record<string, unknown>) => string;
+    // Adapter overrides (advanced — Extension Bridge)
+    schemaConverter?: SchemaConverter;
+    annotationMapper?: AnnotationMapper;
+    errorMapper?: ErrorMapper;
   }
 ): Promise<void>;
 ```
 
-**Additional options:**
+**Options reference:**
+
+*Transport*
+- `transport` — `"stdio"` (default), `"streamable-http"`, or `"sse"`
+- `host` — Host address for HTTP-based transports. Default: `"127.0.0.1"`
+- `port` — Port for HTTP-based transports. Default: `8000`
+
+*Identity*
+- `name` — MCP server name. Default: `"apcore-mcp"`
+- `version` — MCP server version. Default: package version
+
+*Lifecycle*
+- `onStartup` — Async callback invoked before the server starts
+- `onShutdown` — Async callback invoked after the server stops (or on error)
+
+*Module filtering / discovery*
+- `tags` — Filter modules by tag list. Default: `null` (no filtering)
+- `prefix` — Filter modules by ID prefix. Default: `null` (no filtering)
+- `dynamic` — Enable dynamic tool registration via `RegistryListener`. Default: `false`
+- `validateInputs` — Validate inputs against schemas before dispatch. Default: `false`
+- `logLevel` — Minimum log level. Suppresses console methods below this level
 
+*Async Task Bridge (F-043)*
+- `async` — Enable the AsyncTaskBridge and `__apcore_task_*` meta-tools. Pass `false` to disable, or `{ maxConcurrent, maxTasks }` for fine-grained tuning. Default: `true`
+
+*Executor wiring*
+- `middleware` — Array of apcore `Middleware` instances installed via `executor.use()`. Appended to any middleware declared under Config Bus key `mcp.middleware`
+- `acl` — Optional apcore `ACL` instance installed via `executor.setAcl()`. Caller-supplied ACL takes precedence over `mcp.acl` Config Bus entry
+- `approvalHandler` — Optional approval handler passed to the Executor (e.g. `ElicitationApprovalHandler`)
+- `strategy` — Execution strategy name passed to the Executor (e.g. `"standard"`, `"internal"`)
+
+*Observability (F-044)*
+- `metricsCollector` — `MetricsExporter` instance, or `true` to auto-instantiate apcore-js's `MetricsCollector` and install `MetricsMiddleware`
+- `observability` — Enable the full observability stack (metrics + usage middleware) and expose `/metrics` + `/usage` endpoints
+- `trace` — When `true`, enables pipeline trace via `callWithTrace()`. Adds `_meta.trace` to non-streaming tool responses. Default: `false`
+
+*Output handling*
+- `outputFormatter` — Custom function to format tool execution results. When undefined, results are serialized with `JSON.stringify(result)`
+- `redactOutput` — When `true` (default), redact sensitive fields from tool output via apcore's `redactSensitive()` before formatting
+
+*Auth (HTTP transports only)*
+- `authenticator` — `Authenticator` instance for request authentication
+- `requireAuth` — If `true` (default), unauthenticated requests are rejected with 401. Set to `false` for permissive mode
+- `exemptPaths` — Paths exempt from authentication. Default: `["/health", "/metrics"]`
+
+*Tool Explorer UI*
+- `explorer` — Enable the browser-based Tool Explorer UI (HTTP only). Default: `false`
+- `explorerPrefix` — URL prefix for the explorer. Default: `"/explorer"`
+- `allowExecute` — Allow tool execution from the explorer UI. Default: `false`
 - `explorerTitle` — Custom title for the Tool Explorer UI page
 - `explorerProjectName` — Project name shown in the explorer UI footer
 - `explorerProjectUrl` — Project URL shown in the explorer UI footer
-- `requireAuth` — If `true` (default), unauthenticated requests are rejected with 401. Set to `false` for permissive mode
-- `outputFormatter` — Custom function to format tool execution results. When undefined, results are serialized with `JSON.stringify(result)`
+
+*Adapter overrides (advanced — Extension Bridge, F-042)*
+- `schemaConverter` — Override the default `SchemaConverter` (custom JSON Schema strictness/dialect)
+- `annotationMapper` — Override the default `AnnotationMapper` (custom annotation wire format)
+- `errorMapper` — Override the default `ErrorMapper` consumed by `ExecutionRouter`
 
 ### `asyncServe(registryOrExecutor, options?)`
 
@@ -228,6 +377,22 @@ await close();
 
 Accepts the same options as `serve()` except `transport`, `host`, `port`, `onStartup`, and `onShutdown`.
 
+### Output Formatting
+
+By default, tool execution results are serialized as JSON (`JSON.stringify`). You can customize this by passing an `outputFormat` name or a custom `outputFormatter` function.
+
+**Built-in formats** (requires `apcore-toolkit` 0.7.0+):
+
+```typescript
+// Via CLI
+// npx apcore-mcp --extensions-dir ./extensions --output-format csv
+
+// Via API
+const mcp = new APCoreMCP("./extensions", { outputFormat: "csv" });
+```
+
+Supports `json`, `csv`, and `jsonl`. Non-tabular data gracefully falls back to JSON.
+
 ### Tool Explorer
 
 When `explorer: true` is passed to `serve()`, a browser-based Tool Explorer UI is mounted on HTTP transports. It provides an interactive page for browsing tool schemas and testing tool execution.
@@ -265,7 +430,7 @@ apcore-mcp supports JWT Bearer token authentication for HTTP-based transports.
 import { serve, JWTAuthenticator } from "apcore-mcp";
 
 const authenticator = new JWTAuthenticator({
-  secret: "your-secret-key",
+  key: "your-secret-key",
   algorithms: ["HS256"],
   audience: "my-app",
   issuer: "auth-service",
@@ -299,8 +464,9 @@ await serve(executor, {
 | `--jwt-algorithm` | `HS256` | JWT algorithm |
 | `--jwt-audience` | — | Expected audience claim |
 | `--jwt-issuer` | — | Expected issuer claim |
-| `--jwt-require-auth` | `true` | Require auth. Use `--no-jwt-require-auth` for permissive mode |
-| `--exempt-paths` | `/health,/metrics` | Comma-separated paths exempt from auth |
+| `--jwt-require-auth` | `true` | Require auth. Use `--jwt-permissive` to allow unauthenticated requests |
+| `--jwt-permissive` | `false` | Overrides `--jwt-require-auth` and allows unauthenticated requests |
+| `--exempt-paths` | `/health,/metrics,/usage` | Comma-separated paths exempt from auth |
 
 JWT key resolution priority: `--jwt-key-file` > `--jwt-secret` > `APCORE_JWT_SECRET` environment variable.
 
@@ -317,6 +483,67 @@ curl -X POST http://localhost:8000/mcp \
 curl http://localhost:8000/health
 ```
 
+#### Per-request identity helpers
+
+When auth is enabled, each request runs inside an `AsyncLocalStorage`
+context whose value is the verified `Identity`. Modules and middleware
+read it with `getCurrentIdentity()` — no need to thread it through every
+function.
+
+```typescript
+import { getCurrentIdentity, identityStorage } from "apcore-mcp";
+import type { Identity } from "apcore-mcp";
+
+// Inside a module / middleware called from a tool invocation:
+const id: Identity | null = getCurrentIdentity();
+if (id) {
+  // id.id (user id), id.type ("user" | "service" | ...), id.roles, id.attrs
+}
+
+// Lower-level access (e.g. for running custom code inside a known identity):
+identityStorage.run(myIdentity, async () => {
+  /* code that calls getCurrentIdentity() */
+});
+```
+
+Python parity: `apcore_mcp.get_current_identity()` / `auth_identity_var`.
+Rust parity: `apcore_mcp::AUTH_IDENTITY` task-local.
+
+#### Mounting the Explorer behind your own server
+
+If you embed the bridge via `asyncServe(...)` instead of `serve(...)`,
+gate the explorer routes behind an auth hook with
+`buildExplorerAuthHook(authenticator)`:
+
+```typescript
+import { buildExplorerAuthHook } from "apcore-mcp";
+import { JWTAuthenticator } from "apcore-mcp";
+
+const auth = new JWTAuthenticator({ key: process.env.JWT_SECRET! });
+const guard = buildExplorerAuthHook(auth);
+
+// `guard` is a `(req, next) => Promise<Response>` hook accepted by
+// mcp-embedded-ui's Hono router. Returns a 401 response when the
+// Authorization header is missing or invalid; otherwise runs `next()`
+// inside `identityStorage.run(identity, ...)` so the explorer's
+// downstream handlers see the authenticated identity.
+```
+
+#### Custom observability stack (advanced)
+
+For callers who don't want the `serve(... observability: true)` shorthand,
+`installObservability` wires the metrics + usage middleware onto an
+existing `Executor` directly. It is what `serve()` calls internally.
+
+```typescript
+import { installObservability } from "apcore-mcp";
+import type { ObservabilityFlag } from "apcore-mcp";
+
+const stack = await installObservability(executor, /* metricsCollector */ null, true satisfies ObservabilityFlag);
+// stack.metricsCollector / stack.usageCollector are then exposed on
+// the `/metrics` and `/usage` endpoints by your own HTTP wiring.
+```
+
 ### `toOpenaiTools(registryOrExecutor, options?)`
 
 Export apcore modules as OpenAI-compatible tool definitions.

package/dist/acl-builder.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Build an apcore `ACL` instance from a Config Bus `mcp.acl` section.
+ *
+ * Config Bus schema (YAML, shared across Python/TS/Rust bridges):
+ *
+ * ```yaml
+ * mcp:
+ *   acl:
+ *     default_effect: deny          # or "allow" — default "deny" (fail-secure)
+ *     rules:
+ *       - callers: ["role:admin"]
+ *         targets: ["sys.*"]
+ *         effect: allow
+ *         description: "Admins can reach system modules"
+ *       - callers: ["*"]
+ *         targets: ["sys.reload", "sys.toggle"]
+ *         effect: deny
+ *         conditions:
+ *           identity_types: ["human", "system"]
+ * ```
+ *
+ * Mirrors the Python `acl_builder.build_acl_from_config` contract. Invalid
+ * entries throw so misconfiguration fails loudly at startup.
+ */
+export interface AclConfigRule {
+    callers: string[];
+    targets: string[];
+    effect: string;
+    description?: string;
+    conditions?: Record<string, unknown> | null;
+}
+export interface AclConfigSection {
+    default_effect?: string;
+    rules?: AclConfigRule[];
+}
+/**
+ * Construct an apcore `ACL` from a Config Bus `mcp.acl` mapping.
+ *
+ * Returns `null` when `aclConfig` is falsy (no ACL section configured).
+ * Throws on malformed entries.
+ */
+export declare function buildAclFromConfig(aclConfig: unknown): Promise<unknown | null>;
+//# sourceMappingURL=acl-builder.d.ts.map

package/dist/acl-builder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"acl-builder.d.ts","sourceRoot":"","sources":["../src/acl-builder.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAWH,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;CAC7C;AAED,MAAM,WAAW,gBAAgB;IAC/B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,KAAK,CAAC,EAAE,aAAa,EAAE,CAAC;CACzB;AAED;;;;;GAKG;AACH,wBAAsB,kBAAkB,CACtC,SAAS,EAAE,OAAO,GACjB,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,CA+GzB"}