Back to MCP Overview

Sharing Tools

Tools for creating and managing share links.

9 tools

Available Tools

sharing_createShare

Create a share link for a resource (file, flow, base, folder)

Input Schema

resourceTypestringrequired

Resource type: "FILE", "FLOW", "BASE", or "FOLDER"

resourceIdstringrequired

ID of the resource to share

accessTypestring

"RESTRICTED" for specific users, "ANYONE_WITH_LINK" for public

permissionstring

Permission level (a new link: VIEWER; sharing again: left as it was unless sent)

sharedWithstring

Email for restricted shares

allowDownloadboolean

Allow downloading (a new link: true; sharing again: left as it was unless sent)

allowCopyboolean

Allow copying (a new link: false; sharing again: left as it was unless sent)

requireAuthboolean

Require login to access (a new link: false; sharing again: left as it was unless sent)

expiresAtstring

Expiration date

passwordstring

Password protection (will be hashed). Left out when sharing again keeps the existing password — also for the new link made after a revoke or expiry; "" removes it.

Example Call

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "sharing_createShare",
    "arguments": {
          "resourceType": "example",
          "resourceId": "example",
          "accessType": "example"
    }
  }
}
sharing_getResourceShares

Get all shares for a resource

Input Schema

resourceTypestringrequired

Resource type

resourceIdstringrequired

Resource ID

Example Call

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "sharing_getResourceShares",
    "arguments": {
          "resourceType": "example",
          "resourceId": "example"
    }
  }
}
sharing_getShareByResourceId

Get share info by resource ID (public)

Input Schema

resourceTypestringrequired

Resource type

resourceIdstringrequired

Resource ID

Example Call

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "sharing_getShareByResourceId",
    "arguments": {
          "resourceType": "example",
          "resourceId": "example"
    }
  }
}
sharing_getShareByToken

Get share info by token (public)

Input Schema

shareTokenstringrequired

Share token from the URL

passwordstring

Password if share is protected

Example Call

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "sharing_getShareByToken",
    "arguments": {
          "shareToken": "example",
          "password": "example"
    }
  }
}
sharing_updateShare

Update share settings

Input Schema

shareIdstringrequired

Share ID to update

accessTypestring

New access type

permissionstring

New permission level

allowDownloadboolean

Allow downloading

allowCopyboolean

Allow copying

requireAuthboolean

Require login to access

expiresAtstring

New expiration (null to remove)

passwordstring

New password (null or "" removes it)

Example Call

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "sharing_updateShare",
    "arguments": {
          "shareId": "example",
          "accessType": "example",
          "permission": "example"
    }
  }
}
sharing_revokeShare

Revoke a share link

Input Schema

shareIdstringrequired

Share ID to revoke

Example Call

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "sharing_revokeShare",
    "arguments": {
          "shareId": "example"
    }
  }
}
sharing_deleteShare

Permanently delete a share

Input Schema

shareIdstringrequired

Share ID to delete

Example Call

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "sharing_deleteShare",
    "arguments": {
          "shareId": "example"
    }
  }
}
sharing_recordActivity

Record that a shared link was viewed or downloaded

Input Schema

shareTokenstringrequired

Share token from the URL

actionstringrequired

What the visitor did: "VIEWED" or "DOWNLOADED"

Example Call

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "sharing_recordActivity",
    "arguments": {
          "shareToken": "example",
          "action": "example"
    }
  }
}
sharing_getShareActivity

Get activity log for a share

Input Schema

shareIdstringrequired

Share ID

limitnumber

Max activities to return (1-100, default: 50)

offsetnumber

Skip activities for pagination

Example Call

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "sharing_getShareActivity",
    "arguments": {
          "shareId": "example",
          "limit": 0,
          "offset": 0
    }
  }
}