Skip to content

README.md

Latest commit

 

History

History
93 lines (65 loc) · 4.02 KB

README.md

File metadata and controls

93 lines (65 loc) · 4.02 KB

@transcend-io/mcp-server-consent

Alpha — this package is under active development and has not yet been published to npm. APIs may change without notice.

Transcend MCP Server for consent management. Provides tools for managing consent preferences, cookie triage, data flow management, and consent regime configuration.

Requires Node.js ≥ 22.12 (see engines in package.json).

For local runs from this repository, copy secret.env.example to secret.env at the repo root (gitignored) and set your API key (see Run from the monorepo).

Install

When the package is available on npm, install the CLI globally:

npm install -g @transcend-io/mcp-server-consent

Until then, run from a checkout of this repository (see Run from the monorepo below).

Usage

# With TRANSCEND_API_KEY in the environment; from the monorepo use secret.env (see Run from the monorepo)
TRANSCEND_API_KEY=your-api-key transcend-mcp-consent

The process speaks MCP over stdio and is meant to be launched by an MCP client (for example Cursor or Claude Desktop), not used as an interactive shell.

MCP client configuration

npx runs the package’s transcend-mcp-consent binary (see bin in package.json).

{
  "mcpServers": {
    "transcend-consent": {
      "command": "npx",
      "args": ["-y", "@transcend-io/mcp-server-consent"],
      "env": {
        "TRANSCEND_API_KEY": "your-api-key"
      }
    }
  }
}

When developing in this repository, reuse the same variable names from root secret.env in the env block, or use your client’s env-file support if it has one.

Run from the monorepo

  1. Credentials — From the repository root, copy secret.env.example to secret.env and set TRANSCEND_API_KEY (and optional URL overrides).

  2. Build and run — node ./dist/cli.mjs matches the transcend-mcp-consent bin (use node because pnpm exec transcend-mcp-consent may not resolve this package’s own binary in a pnpm workspace):

# from the repository root — builds this package and its dependencies (e.g. mcp-server-core)
pnpm exec turbo run build --filter="@transcend-io/mcp-server-consent..."
set -a && source ./secret.env && set +a
pnpm -F @transcend-io/mcp-server-consent exec node ./dist/cli.mjs

Alternative: ./scripts/mcp-run.sh ./packages/mcp/mcp-server-consent/dist/cli.mjs (sources secret.env when present; run after build).

See CONTRIBUTING.md for workspace layout and pnpm --filter workflows.

Environment variables

Variable Required Default Description
TRANSCEND_API_KEY Yes — Transcend API key
TRANSCEND_GRAPHQL_URL No https://api.transcend.io GraphQL API URL

Monorepo: keep these in root secret.env (from secret.env.example); see Run from the monorepo.

Tools

  • consent_get_preferences — Get consent preferences for a user
  • consent_set_preferences — Set consent preferences
  • consent_list_purposes — List tracking purposes
  • consent_list_data_flows — List data flows
  • consent_list_airgap_bundles — List Airgap bundles
  • consent_list_regimes — List consent regimes
  • consent_list_triage_cookies — List cookies for triage
  • consent_list_triage_data_flows — List data flows for triage
  • consent_get_triage_stats — Get cookie/data flow triage statistics
  • consent_update_cookies — Update cookies (approve, junk, assign purposes)
  • consent_update_data_flows — Update data flows
  • consent_bulk_triage — Bulk approve or junk cookies and data flows

Related packages

Also available as part of the unified @transcend-io/mcp-server which includes all domains. See the root README for the full list.