Skip to content

README.md

Latest commit

 

History

History
94 lines (65 loc) · 4.79 KB

README.md

File metadata and controls

94 lines (65 loc) · 4.79 KB

@transcend-io/mcp-server

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

Unified Transcend MCP Server that combines all domain tools into a single server. This is the "everything in one place" option — install this package when you want access to all Transcend tools at once.

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

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

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 binary (see bin in package.json). Add to your MCP client config (for example Claude Desktop or Cursor):

{
  "mcpServers": {
    "transcend": {
      "command": "npx",
      "args": ["-y", "@transcend-io/mcp-server"],
      "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 bin (use node because pnpm exec transcend-mcp may not resolve this package's own binary in a pnpm workspace):

# from the repository root — builds the unified server, all domain packages, and mcp-server-core
pnpm exec turbo run build --filter="@transcend-io/mcp-server..."
set -a && source ./secret.env && set +a
pnpm -F @transcend-io/mcp-server exec node ./dist/cli.mjs

Alternative: ./scripts/mcp-run.sh ./packages/mcp/mcp-server/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.

Architecture

This package composes all domain MCP packages via ToolRegistry, which aggregates tools from each domain (getConsentTools, getDSRTools, etc.) into a single tool namespace. A composed TranscendGraphQLClient mixes in all domain GraphQL capabilities so each tool has access to the API surface it needs.

If the tool count is too many for your AI agent, install individual domain packages instead — see the MCP section of the root README.

Related packages

Package Binary Domain
@transcend-io/mcp-server-admin transcend-mcp-admin Organization, users, API keys
@transcend-io/mcp-server-assessments transcend-mcp-assessments Privacy assessments
@transcend-io/mcp-server-consent transcend-mcp-consent Consent management, cookie triage
@transcend-io/mcp-server-core — Shared infrastructure
@transcend-io/mcp-server-discovery transcend-mcp-discovery Data discovery, classification
@transcend-io/mcp-server-dsr transcend-mcp-dsr Data subject requests
@transcend-io/mcp-server-inventory transcend-mcp-inventory Data inventory, silos, vendors
@transcend-io/mcp-server-preferences transcend-mcp-preferences Privacy preferences
@transcend-io/mcp-server-workflows transcend-mcp-workflows Workflow configuration