Skip to main content

MCP Tools Reference

Complete reference of all available MCP tools, grouped by category.

Configure which tools are exposed with the FYSO_TOOLS environment variable. See Tool Profiles.


Tenant

ToolProfileDescription
list_tenantscoreList accessible tenants
select_tenantcoreSelect active tenant for subsequent operations

Entities

ToolProfileDescription
generate_entitycoreCreate entity with fields from JSON definition
list_entitiescoreList entities (optionally include drafts)
get_entity_schemacoreGet full entity definition and field list
publish_entitycorePublish entity version with message
delete_entityadvancedDelete entity and all its records (irreversible)
list_entity_changesadvancedView version history
manage_custom_fieldsadvancedAdd, update, or delete custom fields

Records

ToolProfileDescription
query_recordscoreQuery records with filters, pagination, sorting, and semantic search
create_recordcoreCreate a new record
update_recordcorePartially update a record
delete_recordcoreDelete a record

Views

ToolProfileDescription
create_viewcoreCreate a filtered entity view with independent RBAC permissions
list_viewscoreList all entity views in the current tenant
update_viewcoreUpdate a view's name, description, filter, or active status
delete_viewcoreDelete an entity view

Business Rules

ToolProfileDescription
generate_business_rulecoreGenerate and create a rule from natural language or DSL JSON
create_business_rulecoreCreate rule from explicit DSL definition
list_business_rulescoreList rules for an entity
get_business_rulecoreGet full rule definition
publish_business_rulecorePublish rule (only published rules execute)
test_business_ruleadvancedTest rule with sample data without saving
delete_business_ruleadvancedDelete a rule
get_rule_logsadvancedView execution logs for a rule

RBAC (Roles & Permissions)

ToolProfileDescription
list_rolescoreList roles defined in the tenant
create_rolecoreCreate a new role with permissions
assign_rolecoreAssign a role to a user
revoke_rolecoreRevoke a role from a user

Users

ToolProfileDescription
create_usercoreCreate tenant user with role and permissions
list_userscoreList users in the tenant
update_user_passwordcoreReset any user's password (admin operation, no current password required)
tenant_loginadvancedAuthenticate as tenant user, returns JWT

Anonymous API Keys

ToolProfileDescription
create_anonymous_keyadvancedCreate an anonymous API key for public access (TTL required)
list_anonymous_keysadvancedList anonymous keys — metadata only, no key values
revoke_anonymous_keyadvancedImmediately revoke an anonymous API key

Files

ToolProfileDescription
upload_filecoreUpload a file, returns stored file metadata

PDF

ToolProfileDescription
generate_pdfcoreGenerate PDF from template and record data
create_pdf_templatecoreCreate a PDF template

Static Sites

ToolProfileDescription
deploy_static_sitecoreDeploy static site to *.sites.fyso.dev
list_static_sitescoreList deployed sites
delete_static_siteadvancedDelete a site
generate_deploy_tokenadvancedGenerate one-time deploy token for CI/CD
set_custom_domainadvancedAdd, verify, check, or remove a custom domain for a site (Pro)

API

ToolProfileDescription
get_rest_api_speccoreGet OpenAPI spec for the tenant's entities
generate_api_clientcoreGenerate API client code in a given language

Metadata

ToolProfileDescription
export_metadatacoreExport tenant structure (entities, fields, rules) as JSON
import_metadatacoreImport metadata JSON into tenant

Apps

ToolProfileDescription
publish_appcorePublish tenant as installable app
unpublish_appcoreUnpublish app
update_appcoreUpdate app name, description, or refresh metadata

Scheduling

ToolProfileDescription
get_available_slotscoreGet available time slots for a professional
create_bookingcoreCreate a booking in an available slot

Secrets

ToolProfileDescription
set_secretadvancedStore an encrypted secret for use in flows
delete_secretadvancedDelete a stored secret

Flows

ToolProfileDescription
create_flowadvancedCreate an automation flow with triggers and steps
list_flowsadvancedList flows in the tenant
update_flowadvancedUpdate flow definition
delete_flowadvancedDelete a flow
toggle_flowadvancedEnable or disable a flow

Webhooks

ToolProfileDescription
create_webhookadvancedSubscribe to entity record events (created/updated/deleted)
list_webhooksadvancedList webhook subscriptions, optionally filtered by entity
delete_webhookadvancedDelete a webhook subscription

Knowledge Base

ToolProfileDescription
upload_documentcoreUpload document for RAG indexing (PDF, HTML, text, markdown, URL)
search_knowledgecoreSemantic search across indexed documents. Supports one_per_document, threshold, document_ids
list_documentscoreList uploaded documents with status filtering
get_documentcoreGet document metadata, content, and chunk preview
delete_documentadvancedDelete a document and all its chunks (tracked via knowledge_delete event)
get_knowledge_statscoreGet indexing stats, search analytics, and embedding token usage (30-day window)

Channels & Bots

These tools are only available with profile all.

ToolProfileDescription
search_channelsallSearch for channels
get_channel_infoallGet channel metadata
execute_channel_toolallExecute a tool in a channel
get_my_channelallGet the current bot's own channel
list_channel_toolsallList tools available in a channel