@kadoa/mcp 0.6.2 → 0.6.4

package/README.md

@@ -2,6 +2,73 @@
 
 Use [Kadoa](https://kadoa.com) from ChatGPT, Claude.ai, Claude Code, Cursor, and other MCP clients.
 
+## Authentication
+
+Public API is the only OAuth authority. This server is an MCP resource server:
+it publishes protected-resource metadata, verifies RS256 resource tokens against
+Public API JWKS, enforces the exact issuer and resource audience, and exchanges
+each resource token for a request-local Public API token using workload identity.
+It does not mount authorization, registration, token, refresh, or revocation
+routes and does not store credentials.
+
+```sh
+MCP_AUTH_ISSUER=https://api.kadoa.com/v5/auth
+MCP_AUTH_JWKS_URL=https://api.kadoa.com/v5/auth/.well-known/jwks.json
+MCP_AUTH_AUDIENCE=https://mcp.kadoa.com/mcp
+MCP_DOWNSTREAM_TOKEN_ENDPOINT=https://api.kadoa.com/v5/auth/mcp/downstream-token
+MCP_DOWNSTREAM_WORKLOAD_AUDIENCE=https://api.kadoa.com/v5/auth/mcp/downstream-token
+MCP_ALLOWED_ORIGIN_HOSTNAMES=mcp.kadoa.com,service.mcp.kadoa.com
+MCP_LEGACY_TRANSPORT_ENABLED=true
+```
+
+`MCP_LEGACY_TRANSPORT_ENABLED` controls protocol-version compatibility only.
+When `true`, supported 2025 protocol requests use the same central verifier and
+downstream exchange as modern requests. It never selects another authentication
+implementation. Missing central configuration fails startup.
+
+### Interactive local central-mode proof
+
+The normal `dev` entrypoint uses Google workload identity in central mode. For a
+local Dashboard Assistant proof, use the test-only launcher. It imports the real
+backend downstream-exchange owner and replaces only Google's identity-token
+verification with a deterministic local identity. It refuses to start unless
+`KADOA_ENVIRONMENT=local`, binds to `127.0.0.1:3002`, and is not included in the
+published package build.
+
+Start the backend services without the regular MCP child. The shared environment
+pins the backend issuer, Assistant MCP URL, resource audience, and downstream
+Public API audience to literal loopback addresses. If the backend root `.env`
+defines `KADOA_MCP_TOKEN_ALLOWED_RESOURCES`, set it to
+`http://127.0.0.1:3002/mcp` as well. Backend package processes load that file and
+a conflicting value makes the Assistant exchange fail with `invalid_target`.
+The backend `turbo.json` dev task must propagate every variable exported by
+`local-central-env.sh`; the launcher checks this before it starts.
+
+```sh
+cd /home/gabrielziegler/kadoa/kadoa-backend
+direnv exec . bash -lc '
+  source /home/gabrielziegler/kadoa/kadoa-mcp/tests/integration/local-central-env.sh
+  ./start-kadoa.sh --quick --services=dashboard,api,shelly,events-gateway,operations
+'
+```
+
+In a second terminal, start the local central resource server with the backend's
+local environment:
+
+```sh
+direnv exec /home/gabrielziegler/kadoa/kadoa-backend bash -lc '
+  source /home/gabrielziegler/kadoa/kadoa-mcp/tests/integration/local-central-env.sh
+  cd /home/gabrielziegler/kadoa/kadoa-mcp
+  KADOA_BACKEND_ROOT=/home/gabrielziegler/kadoa/kadoa-backend bun run dev:central-local
+'
+```
+
+Open a new Dashboard Assistant session and request a workflow list. The proof
+covers the central resource server, backend-owned token exchange, live team
+membership checks, downstream Public API credentials, and real tool calls. It
+does not cover Google workload identity, browser OAuth consent, or a deployed
+network boundary. Google workload identity remains a beta check.
+
 ## Remote Server (no install needed)
 
 A hosted MCP server is available at `https://mcp.kadoa.com/mcp`. Connect from any MCP client — no local install needed. You sign in with your Kadoa account via OAuth.
@@ -77,8 +144,6 @@ Point your client to `https://mcp.kadoa.com/mcp` with OAuth authentication.
 | `get_workflow_history` | Get the workflow's configuration revision history (audit log) — who changed it, when, from which channel, and a `changedFields` summary per revision |
 | `list_activity` | List the team's Activity log (audit trail) across all workflows and resources: actor email, resource name, action, interface, timestamp, change summary; filter by time window, user, workflow, action, interface, resource type. Use `get_workflow_history` for one workflow's config diffs |
 | `list_workflow_runs` | List a workflow's execution run history (status, start/finish, record count, errors); filter by outcome and paginate |
-| `get_usage` | Current plan usage for the active team or its organization: workflow slot quota and usage, billable and active workflows, extracted rows, billing period and renewal date |
-| `get_usage_history` | Daily usage history (active workflows, billing-period cumulative, or daily activity) for up to 366 days |
 | `get_observability` | Team-wide workflow health for a window of days: uptime, failed runs, MTTR, records delivered, health counts, and a ranked list of down or degraded workflows (the Observability page data) |
 | `run_workflow` | Execute a workflow |
 | `fetch_data` | Get extracted data from a workflow |
@@ -98,7 +163,6 @@ For detailed customer guidance, see the [Kadoa documentation](https://docs.kadoa
 - **Run history:** `list_workflow_runs` filters by `status` (`success`, `failed`, or `in_progress`) and supports 1-based `page` and `limit` pagination.
 - **Notifications:** `create_realtime_monitor` requires at least one email, webhook, Slack, or WebSocket notification channel. Notifications are optional when creating a standard one-time or scheduled workflow with `create_workflow`.
 - **Template changes:** `update_template` changes template name and description only. To change template-controlled configuration, create an immutable version with `create_template_version`, then roll it out to linked workflows with `apply_template_version`.
-- **Usage:** `get_usage` reports slots and rows, not credits. `usedThisPeriod` resets at the renewal date; `usedActive` is the current slot count; `usedAllTime` never resets. Pass `scope: "organization"` to match the Usage page for organization members.
 
 ## Usage Examples
 
@@ -304,7 +368,7 @@ Use this when you want to validate a change end-to-end against real clients (Cla
 There are two ways to consume an RC:
 
 - **Local stdio**: `npx @kadoa/mcp@rc` — installs from the `rc` dist-tag on npm. Good for quick sanity checks where the bug doesn't depend on the hosted OAuth flow.
-- **Hosted `mcp-server-test`**: a separate k8s deployment alongside prod in the same GKE cluster. Required when you need to validate the OAuth callback, Redis token store, multi-tenant session behavior, etc.
+- **Hosted `mcp-server-test`**: a separate k8s deployment alongside prod in the same GKE cluster. Use it to validate protected-resource discovery, OAuth callbacks owned by Public API, and multi-tenant behavior.
 
 #### Publish an RC to npm
 
@@ -383,13 +447,18 @@ The server starts in HTTP mode. You authenticate via OAuth the same way as with
 
 ### HTTP server environment variables
 
-Opaque OAuth bearer tokens are routed to the existing OAuth verifier. RS256 Kadoa access tokens (Public API tokens, including delegated Kadoa Assistant tokens) additionally require:
+| Variable | Description |
+|---|---|
+| `MCP_AUTH_ISSUER` | Exact Public API OAuth issuer, such as `https://api.kadoa.com/v5/auth` |
+| `MCP_AUTH_JWKS_URL` | JWKS URL for the issuer |
+| `MCP_AUTH_AUDIENCE` | Exact MCP resource URL served by this deployment; its path must be `/mcp` |
+| `MCP_DOWNSTREAM_TOKEN_ENDPOINT` | Public API workload-authenticated downstream exchange endpoint |
+| `MCP_DOWNSTREAM_WORKLOAD_AUDIENCE` | Audience used when the MCP workload requests its Google ID token |
+| `MCP_ALLOWED_ORIGIN_HOSTNAMES` | Comma-separated hostnames admitted when an HTTP Origin header is present; required outside loopback |
+| `MCP_LEGACY_TRANSPORT_ENABLED` | `true` serves supported 2025 protocol versions through central auth; `false` rejects them |
 
-| Variable | Description | If unset |
-|---|---|---|
-| `MCP_AUTH_ISSUER` | Issuer of Public API RS256 access tokens, `https://api.kadoa.com/v5/auth` | RS256 bearers rejected |
-| `MCP_AUTH_JWKS_URL` | JWKS of that issuer, `https://api.kadoa.com/v5/auth/.well-known/jwks.json` | RS256 bearers rejected |
-| `MCP_AUTH_AUDIENCE` | This pod's exact resource URL, e.g. `https://beta.mcp.kadoa.com/mcp` — must match the pod actually serving the request; a value copied from another pod's config cross-accepts that pod's tokens | RS256 bearers rejected |
+All authentication and downstream-exchange settings are required. Old opaque
+MCP bearer credentials are rejected.
 
 ## Contributing
 
@@ -450,10 +519,10 @@ CLI and MCP both call **identical** SDK domain methods. A new feature added to t
 ### Where to find things in this repo
 
 - `src/tools.ts` — every MCP tool. Single file by design; search for the tool name.
-- `src/auth.ts` — OAuth flow, JWT verification, team selection.
-- `src/client.ts` — wires `@kadoa/node-sdk` per request, injects bearer token.
-- `src/http.ts` — Express server, transport adapter, session handling.
-- `src/redis-store.ts` — token store for the hosted server.
+- `src/kadoa-access-token.ts` — verifies Public API resource tokens.
+- `src/downstream-token.ts` — exchanges resource tokens for request-local Public API credentials.
+- `src/client.ts` — wires `@kadoa/node-sdk` per request.
+- `src/http.ts` — Express resource server and transport adapter.
 - `tests/unit/` — bun tests; run with `bun run test`.
 
 ## License