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

sharedWithstring

Email for restricted shares

allowDownloadboolean

Allow downloading

allowCopyboolean

Allow copying

requireAuthboolean

Require login to access

expiresAtstring

Expiration date

passwordstring

Password protection (will be hashed)

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 to remove)

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 share activity (views, downloads)

Input Schema

shareTokenstringrequired

Share token from the URL

actionstringrequired

Activity action type

actorEmailstring

Email of the viewer (if known)

ipAddressstring

IP address

userAgentstring

Browser user agent

metadataobject

Additional metadata

Example Call

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "sharing_recordActivity",
    "arguments": {
          "shareToken": "example",
          "action": "example",
          "actorEmail": "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
    }
  }
}
Sharing MCP Tools - Serenities