# Teralynk MCP Server

> Connect any MCP-compatible AI assistant to Teralynk — AI-native file intelligence, PII scanning, compliance automation, workflow execution, audit trails, and data subject rights management.

[![npm version](https://img.shields.io/npm/v/@teralynk/mcp-server)](https://www.npmjs.com/package/@teralynk/mcp-server)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)

## What it does

The Teralynk MCP Server exposes your entire Teralynk account as structured tools your AI can call directly. Ask Claude to scan a file for HIPAA violations, check your compliance score, generate a PDF report, run a workflow, or submit a GDPR data subject access request — all without leaving the conversation.

**v1.6.1** — 102 tools across 13 categories with plan-based gating (free / SMB / enterprise), BYOK AI chat, per-tool metering, audit attribution, and remote feature flags.

## Quick Start

### 1. Get your API key

Sign in at [teralynk.com](https://www.teralynk.com) → **Developer → API Keys** → create a new key (starts with `tlk_`).

### 2. Add to Claude Desktop

Edit `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS) or `%APPDATA%\Claude\claude_desktop_config.json` (Windows):

```json
{
  "mcpServers": {
    "teralynk": {
      "command": "npx",
      "args": ["-y", "@teralynk/mcp-server"],
      "env": {
        "TERALYNK_API_KEY": "tlk_your_key_here"
      }
    }
  }
}
```

Restart Claude Desktop. The Teralynk tools appear automatically.

### 3. Other MCP clients (Cursor, Kiro, Continue, etc.)

```
Command: npx -y @teralynk/mcp-server
Env:     TERALYNK_API_KEY=tlk_your_key_here
```

---

## Pricing Tiers & Tool Access

| Tier | Tools | Includes |
|------|-------|----------|
| **Free** | 13 tools | Read-only: list/search/get files, compliance score, analytics, notifications, billing, conversations, frameworks |
| **SMB / Pro** | 72 tools | Free + upload, rename, move, copy, bulk ops, locking, version restore, content search, scanning, reports, file protection, workflows, tagging, agents |
| **Enterprise** | All 102 tools | SMB + webhooks, security events, scheduled reports, API key management, team management, file retention, compliance certificates, DSARs, audit export |

---

## Tools (102 total)

### Files (28 tools)

| Tool | Tier | Description |
|------|------|-------------|
| `list_files` | Free | List the authenticated user's files in Teralynk |
| `search_files` | Free | Full-text search across file names and metadata |
| `get_file` | Free | Get full metadata for a specific file: name, size, type, storage provider, tags, created/modified da |
| `get_file_download_url` | Free | Get a presigned download URL for a file |
| `get_file_versions` | Free | List all versions of a file with timestamps and sizes |
| `delete_files` | SMB | Permanently delete one or more files |
| `star_file` | SMB | Star or unstar a file for quick access later |
| `share_file` | SMB | Generate a shareable link for a file |
| `upload_file` | SMB | Get a presigned upload URL for a file |
| `rename_file` | SMB | Rename a file in Teralynk storage |
| `tag_file` | SMB | Add one or more tags to a file |
| `untag_file` | SMB | Remove one or more tags from a file |
| `list_shared_files` | SMB | List files that currently have active share links |
| `revoke_share` | SMB | Revoke all active sharing links for a file |
| `get_file_tags` | SMB | Get all tags currently applied to a file |
| `download_file_content` | SMB | Download and return the text content of a file (up to 100 KB) |
| `bulk_tag_files` | SMB | Apply one or more tags to multiple files at once |
| `move_file` | SMB | Move a file to a different folder within your Teralynk storage |
| `create_folder` | SMB | Create a new empty folder in your Teralynk storage |
| `get_file_sharing_info` | SMB | See who a file is currently shared with, link expiry, and permission level |
| `duplicate_file` | SMB | Create a copy of a file in the same or a different folder |
| `restore_file_version` | SMB | Restore a file to a previous version |
| `lock_file` | SMB | Lock a file to prevent edits by other team members |
| `unlock_file` | SMB | Unlock a previously locked file so other team members can edit it |
| `bulk_download` | SMB | Get presigned download URLs for multiple files at once |
| `bulk_move` | SMB | Move multiple files to a destination folder in one operation |
| `bulk_delete` | SMB | Delete multiple files at once |
| `search_file_content` | SMB | Semantic full-text search across file contents (not just filenames) |

### PII Scanning (7 tools)

| Tool | Tier | Description |
|------|------|-------------|
| `scan_file_for_pii` | SMB | Scan a specific file for PII |
| `run_compliance_scan` | SMB | Trigger a compliance scan across all of the user's files |
| `run_full_compliance_scan` | SMB | Run a comprehensive blocking compliance scan of all files |
| `apply_autofix` | SMB | Automatically remediate open compliance violations using AI-generated fixes |
| `cross_file_pii_report` | Enterprise | Generate a cross-file PII exposure report: which files contain SSNs, credit cards, emails, phone num |
| `list_scan_history` | SMB | List previous compliance scan results with dates, findings counts, and status |
| `get_scan_details` | SMB | Get full details of a specific compliance scan run — files scanned, findings, duration, and status |

### Compliance (15 tools)

| Tool | Tier | Description |
|------|------|-------------|
| `get_pii_violations` | SMB | List PII-specific violations found during file scans |
| `resolve_pii_violation` | SMB | Mark a PII violation as resolved |
| `get_compliance_violations` | SMB | List org-level compliance violations — policy breaches, rule failures, and framework gaps |
| `get_compliance_score` | Free | Get the user's real-time compliance health score (0–100) with a breakdown by framework |
| `get_compliance_summary` | SMB | Get an aggregate compliance health summary: total files scanned, open violation counts by severity,  |
| `list_compliance_frameworks` | Enterprise | List all 201 compliance frameworks available on the Teralynk platform, grouped by industry (Finance, |
| `get_file_risk_score` | SMB | Get a risk score (0–100) for a specific file based on PII density, sharing status, access frequency, |
| `compare_files` | SMB | Compare two files side-by-side: metadata, compliance status, PII violations, and protection policies |
| `auto_classify` | SMB | Use AI to automatically classify a file's sensitivity level (public, internal, confidential, restric |
| `schedule_scan` | Enterprise | Create a recurring compliance scan schedule |
| `compliance_diff` | Enterprise | Get compliance violations added since a specific date |
| `remediation_plan` | Enterprise | Generate an AI-powered step-by-step remediation plan for all open compliance violations |
| `data_map` | Enterprise | Get a data map showing where PII flows across files and storage providers |
| `get_violation_details` | SMB | Get full details of a specific compliance violation by ID — file, type, severity, context, and remed |
| `list_frameworks` | Free | List all available compliance frameworks (HIPAA, GDPR, PCI-DSS, etc |

### Reports & Certificates (5 tools)

| Tool | Tier | Description |
|------|------|-------------|
| `list_compliance_reports` | SMB | List previously generated compliance reports with their status, framework coverage, and download URL |
| `generate_compliance_report` | SMB | Generate a new compliance report as a PDF |
| `compliance_certificate` | Enterprise | Generate a compliance attestation certificate PDF for selected frameworks |
| `compliance_report_pdf_url` | SMB | Get the download URL for a previously generated compliance report PDF |
| `schedule_report` | Enterprise | Schedule a recurring report to be generated and emailed |

### File Protection (6 tools)

| Tool | Tier | Description |
|------|------|-------------|
| `protect_files` | SMB | Apply a compliance protection policy to one or more files |
| `unprotect_files` | SMB | Remove compliance protection from one or more files |
| `list_protections` | SMB | List active file protection policies |
| `get_protections_summary` | SMB | Get a summary of active file protections: total protected files, policy breakdown, and framework cov |
| `bulk_protect_by_framework` | Enterprise | Protect all files that match a compliance framework |
| `set_file_retention` | Enterprise | Set a retention policy on files — automatically delete files older than the specified number of days |

### Rules & Whitelist (4 tools)

| Tool | Tier | Description |
|------|------|-------------|
| `list_compliance_rules` | Enterprise | List compliance rules in effect — both global platform rules and any custom org rules |
| `create_compliance_rule` | Enterprise | Create a custom compliance rule for the org |
| `get_whitelist` | Enterprise | Get the compliance whitelist — domains, emails, IPs, file patterns, and users exempt from certain ru |
| `add_to_whitelist` | Enterprise | Add an entry to the compliance whitelist to suppress false positives |

### Audit & Legal (5 tools)

| Tool | Tier | Description |
|------|------|-------------|
| `get_audit_log` | Enterprise | Retrieve the tamper-evident compliance audit trail |
| `export_audit_trail` | Enterprise | Export the compliance audit trail as structured data (JSON) |
| `search_audit_log` | SMB | Search the compliance audit log by action type, file ID, or other criteria |
| `get_file_activity` | SMB | Get recent activity for a specific file: who accessed it, modifications, shares, and scans |
| `get_security_events` | Enterprise | Get recent security events: suspicious logins, unusual download patterns, access from new locations, |

### Data Subject Rights (2 tools)

| Tool | Tier | Description |
|------|------|-------------|
| `submit_dsar` | Enterprise | Submit a Data Subject Access Request (DSAR) — required under GDPR, CCPA, and similar regulations |
| `list_dsars` | Enterprise | List Data Subject Access Requests with their status, requester, type, and due dates |

### Storage (3 tools)

| Tool | Tier | Description |
|------|------|-------------|
| `get_storage_analytics` | SMB | Get storage usage analytics: total bytes used, file count, breakdown by provider (S3, Google Drive,  |
| `list_storage_connections` | SMB | List connected external storage providers (Google Drive, Dropbox, OneDrive, etc |
| `get_storage_recommendations` | SMB | Get AI-generated storage optimization recommendations: files to archive, duplicates to remove, provi |

### Analytics (2 tools)

| Tool | Tier | Description |
|------|------|-------------|
| `get_analytics` | Free | Get usage analytics: file count, total storage used, AI query count, active workflows, and complianc |
| `mark_notification_read` | SMB | Mark one or all notifications as read |

### AI & Conversations (3 tools)

| Tool | Tier | Description |
|------|------|-------------|
| `send_message` | SMB | Send a message to an AI model (Claude, GPT-4o, Gemini, NVIDIA NIM) using YOUR OWN API key (BYOK) |
| `list_conversations` | Free | List previous AI chat conversations with title, last message preview, model used, and timestamps |
| `get_conversation` | Free | Get a specific AI chat conversation by ID, including full message history |

### Jobs & Scheduling (1 tools)

| Tool | Tier | Description |
|------|------|-------------|
| `get_job_status` | Free | Check the status of a long-running async operation — full compliance scan, report generation, or DSA |

### Workflows (7 tools)

| Tool | Tier | Description |
|------|------|-------------|
| `list_workflows` | SMB | List the user's saved workflows (automation pipelines) |
| `run_workflow` | SMB | Execute a workflow by ID |
| `create_workflow` | Enterprise | Create a new automation workflow with named steps |
| `get_workflow_run_status` | SMB | Get detailed status of a workflow run including step-by-step progress, which steps completed, which  |
| `delete_workflow` | SMB | Delete a workflow by ID |
| `update_workflow` | SMB | Update an existing workflow — change its name, description, or steps |
| `cancel_workflow_run` | SMB | Cancel a running workflow execution |

### Billing & API Keys (4 tools)

| Tool | Tier | Description |
|------|------|-------------|
| `get_billing_usage` | Free | Get the current billing period usage: plan name, credits remaining, scans used, storage consumed, an |
| `create_api_key` | Enterprise | Generate a new Teralynk API key (tlk_-prefixed) |
| `list_api_keys` | Enterprise | List all your active API keys with names, creation dates, and last used timestamps |
| `revoke_api_key` | Enterprise | Revoke (disable) an API key |

### Notifications (1 tools)

| Tool | Tier | Description |
|------|------|-------------|
| `get_notifications` | Free | Get the user's recent notifications — file shares, scan completions, violation alerts, workflow upda |

### Agents (2 tools)

| Tool | Tier | Description |
|------|------|-------------|
| `list_agents` | SMB | List all available AI agents (built-in and custom) |
| `run_agent` | SMB | Run an AI agent with a task |

### Teams (4 tools)

| Tool | Tier | Description |
|------|------|-------------|
| `get_team_members` | Enterprise | List all members of your organization/team with their roles and last activity |
| `invite_team_member` | Enterprise | Invite a new member to your organization by email |
| `update_team_member_role` | Enterprise | Change a team member's role (member, admin, compliance_admin) |
| `remove_team_member` | Enterprise | Remove a member from your organization |

### Webhooks & Integrations (3 tools)

| Tool | Tier | Description |
|------|------|-------------|
| `create_webhook` | Enterprise | Create a webhook that fires when specific events occur (file uploaded, scan completed, violation fou |
| `list_webhooks` | Enterprise | List all configured webhooks with their URLs, events, and delivery status |
| `delete_webhook` | Enterprise | Delete a webhook by ID |

---

## 🏪 Build & Sell on the Marketplace

Build custom tools, workflows, or integrations using Teralynk's API — then **sell them on the Teralynk Marketplace** and earn revenue.

### How it works

1. **Build** — Create a custom MCP tool, workflow template, or compliance rule pack using Teralynk's API endpoints
2. **List** — Publish to the [Teralynk Marketplace](https://www.teralynk.com/marketplace) with your pricing
3. **Earn** — Get paid when other Teralynk users purchase or subscribe to your creation

### What you can sell

| Type | Example | Revenue model |
|------|---------|---------------|
| **Custom MCP tools** | Industry-specific compliance scanner | Per-install or subscription |
| **Workflow templates** | "SOC 2 audit preparation pipeline" | One-time purchase |
| **Compliance rule packs** | FINRA rules, NIST 800-53, ISO 27001 | Subscription |
| **AI agent templates** | "Healthcare data classifier agent" | Per-use or subscription |
| **Integration connectors** | Salesforce → Teralynk compliance sync | Monthly fee |

### Get started

Visit [teralynk.com/creator-store](https://www.teralynk.com/creator-store) to register as a creator and publish your first listing.

---

## Example Prompts

```
Upload a file called quarterly-report.pdf
```

```
Scan file abc123 for HIPAA violations and show me what was found
```

```
What's my compliance score? Break it down by framework.
```

```
Which of my files contain SSNs or credit card numbers?
```

```
Generate a compliance certificate for HIPAA and SOX
```

```
Create a workflow that scans new files and protects any with PII
```

```
Give me a remediation plan to reach 100% compliance
```

```
Show my audit trail for the past 7 days and export it
```

```
What's the risk score for file abc123?
```

```
Run my "weekly-cleanup" workflow
```

```
Lock file abc123 — I'm reviewing it
```

```
Show me all my security events from the past week
```

---

## Configuration

| Variable | Required | Description |
|----------|----------|-------------|
| `TERALYNK_API_KEY` | ✅ | Your Teralynk API key (from Developer portal) |
| `TERALYNK_BASE_URL` | ❌ | Override the API base URL (for testing / self-hosted) |
| `MCP_CLIENT_NAME` | ❌ | Identifies the MCP host in audit logs (default: `"teralynk-mcp"`) |

---

## Supported Compliance Frameworks

HIPAA · GDPR · PCI-DSS · SOX · CCPA · FERPA · GLBA · COPPA

---

## 🌍 Platform Languages

Teralynk is available in **23 languages**:

English · Spanish · French · German · Portuguese · Italian · Dutch · Polish · Russian · Turkish · Arabic · Hindi · Chinese · Japanese · Korean · Indonesian · Vietnamese · Thai · Swedish · Danish · Finnish · Norwegian · Ukrainian

The platform auto-detects your browser language. Users can switch languages at any time from settings.

---

## Requirements

- Node.js 20+
- A [Teralynk](https://www.teralynk.com) account

---

## Links

- 🌐 [teralynk.com](https://www.teralynk.com)
- 🔑 [Developer Portal](https://www.teralynk.com/developer)
- 🏪 [Creator Store / Marketplace](https://www.teralynk.com/creator-store)
- 💰 [Pricing](https://www.teralynk.com/pricing)
- 📋 [Changelog](CHANGELOG.md)
- 🐛 [Issues](https://github.com/teralynk/mcp-server/issues)

## License

MIT