Skip to content

Latest commit

 

History

History
90 lines (71 loc) · 6.17 KB

File metadata and controls

90 lines (71 loc) · 6.17 KB

Available Tools

The MCP Server exposes the following tools to AI assistants:

File Operations — Path-Based (STDIO Mode Only)

  • download_file_to_path: Download a file from Kiteworks to local filesystem by file ID
  • upload_file_from_path: Upload a file from local filesystem to a Kiteworks folder

File Operations — Content-Based (All Modes)

  • read_file_contents: Read text file contents into conversation context as UTF8 (not for local download)
  • create_file_from_content: Create a file in Kiteworks from content in conversation context (not for local upload)

File Operations — Metadata (All Modes)

  • get_file_metadata: Retrieve file metadata by ID
  • rename_file: Rename a file by ID
  • move_file: Move one or more files to a different folder
  • copy_file: Copy one or more files into a folder, leaving the originals in place
  • delete_file: Delete one or more files (with confirmation)

Folder Operations

  • get_top_folders: Fetch top-level folders with optional filtering
  • get_folder_children: Fetch folder contents by parent ID with filtering
  • create_folder: Create a new folder with specified options
  • rename_folder: Rename a folder by ID
  • move_folder: Move a folder to a different parent folder
  • delete_folder: Delete one or more folders and their contents (with confirmation)
  • request_file_to_folder: Request files from recipients into a Kiteworks folder via an email invitation with an upload link

Folder & File Members

  • list_members: List the members of a Kiteworks folder or file, including their role and how access was granted (set target_type to folder or file)
  • manage_members: Add, update, or remove members of a folder or file, chosen by action. Folders take exactly one target ID; add on files supports sharing multiple files with the same members in one call. Every action needs confirmation. Omitting the member on remove (files only) removes every member at once

Search Operations

  • search: Search folders and/or files by name
  • search_folders: Search folders only by name
  • search_files: Search files only by name or content

Mail

  • list_mail: List Kiteworks mail messages with optional filters (bucket, status, read state, sender, shared mailbox) and pagination
  • get_mail: Retrieve a single mail message by ID, including subject, body, status, AV/DLP scan status, recipients, and attachments
  • get_mail_counters: Retrieve mailbox counters (draft, inbox, inbox unread, outgoing and its sub-counts, trash)
  • compose_email: Compose, edit, and check a secure Kiteworks message. Writes it to a server-side draft and validates it against Kiteworks policy and, for acl=otp, whether recipients have a phone number on file; returns a validationId to reuse on later calls and on send_email. Calling this and stopping is how a message is saved without sending; each call without a validationId leaves another draft behind
  • send_email: Send a message compose_email has already drafted. Takes only that validationId (plus an optional id cross-check) — no message content, so it sends the draft exactly as validated. Requires confirmation

Forms

  • create_form: Generate Kiteworks Secure Data Forms from templates with preview links
  • get_create_form_schema: Retrieve the JSON schema for form creation

User Operations

  • get_user_info_whoami: Get current Kiteworks user information
  • find_user_by_email: Find a Kiteworks user by their exact email address, returning display name and UUID
  • search_users_ldap: Search the configured LDAP/Active Directory by email or display name

Risk Policies

  • get_risk_policies: Retrieve all Kiteworks risk policies (read-only)

Admin — User Management

  • search_users: Search Kiteworks users via the admin API with optional filters and pagination
  • get_user_metadata: Retrieve detailed information about a single user by UUID (profile, quota, features, device installs, sessions, status)
  • create_user: Create a new user (email and sendNotification required; optional name, profile, verified flag, admin-set password)
  • update_user: Update mutable fields on a user (name, password, suspended, verified, deactivated, active)
  • reset_user_totp: Delete TOTP/authenticator secrets for one or more users, forcing re-enrollment

Admin — Shared Mailboxes

  • list_mailboxes: List shared mailboxes with optional filters and pagination
  • create_mailbox: Convert an existing user into a shared mailbox and assign initial members
  • delete_mailbox: Permanently delete one or more shared mailboxes (irreversible)
  • update_mailbox_members: Replace the full member list of a shared mailbox

Admin — Activity Logs

  • get_user_activity: Retrieve user activity log entries with date range, text search, activity type filter, and pagination
  • get_admin_activity: Retrieve admin activity log entries via the admin API, with date range, free-text search, event/object filtering, and pagination

Admin — User Profiles

  • list_user_profiles: List all user profiles (numeric ID and name)
  • get_profile: Retrieve a single user profile by numeric ID
  • get_profile_eligibility: Test profile mapping rules against a username/email and see which would match
  • list_profile_users: List users assigned to a specific profile with optional filters and pagination
  • create_user_profile: Create a new user profile
  • assign_user_profile: Assign a single user to a profile (promotion or demotion)
  • bulk_assign_profile: Assign one or more users to a profile in bulk, with data-retention controls for demotions

Admin — Security Tags

  • create_tag: Create a new security tag used as a DLP policy condition

Not Yet Released

The following tools exist in the codebase (risk-policy write operations) but are gated behind an internal Unreleased flag with no way to enable them in production builds — they are not available to customers:

  • create_risk_policy, update_risk_policy, delete_risk_policy, validate_risk_policy, get_create_risk_policy_schema, get_policy_reference_data