Skip to content

Tool API and Site Agent

The File Share Tools submodule, file_share_tool, adds five Tool API plugins. It is experimental while Tool API is in beta.

Tool Operation Does
file_share_create Write Shares files and media items with addresses, domain patterns and accounts, optionally emailing invitations
file_share_update Write Adds or removes items and recipients; changes the title, message, expiry or invite setting
file_share_list Read Lists shares, filtered by file, media item, recipient address or issuer
file_share_revoke Write Revokes a share, removes a recipient from one share or everywhere, or revokes an issuer's shares
file_share_log Read A share's sign-ins, downloads and refusals

Runs as the caller

Each tool runs as the account calling it, with the same permissions and checks as the UI:

  • Creating needs Create file shares, and the caller must be able to download every file.
  • Changing or revoking a share needs the right to edit it.
  • Listing shows only the caller's own shares unless they can administer file shares.
  • Removing a recipient everywhere, ending their sign-ins, and revoking another account's shares need Administer file shares. Without it, file_share_revoke with a recipient works across the caller's own shares.
  • Reading activity needs View file share activity as well as the right to edit the share.

No tool result contains a sign-in link, a token or a share's public URL. Agents such as Site Agent send tool results to an AI provider and keep them in transcripts. Links therefore reach recipients only by email, from file_share_create or file_share_update with invite set.

Activity results leave out IP addresses.

Site Agent

The submodule ships file_share_tool.site_agent_tools.yml. It classifies:

  • file_share_create, file_share_update and file_share_revoke as content writes. They have no drafts, so Site Agent asks for approval on every call.
  • file_share_list and file_share_log as reads.

Add the tools to a Site Agent toolset to offer them in chat.