MCP server tool reference

External agents that attach to the Tealfabric MCP server call the tools below. Names are stable tealfabric_* identifiers. Connect the agent first with Connect external agents with the MCP server.

Document information
FieldValue
Canonical URL/docs/07_ai-agents-and-mcp/33_mcp-server-tool-reference
Version (published date)2026-11-13
Tagsmcp, mcp-server, tools, reference

How calls behave

  • tools/list returns this set for any key that has mcp.read or mcp.write. Listing tools does not require a platform skill.
  • tools/call requires mcp.write and the domain scope in the table for that tool.
  • The workspace is the API key’s workspace. Document tools accept an optional tenant_id and ignore it.
  • Tool results are JSON text. A failed call returns text that starts with Error:.
  • This list is the external MCP server. The in-console catalog, including load_platform_skill, is the MCP tool catalog.

connectors.read, connectors.write, and integrations.execute are included in All Operations (Full Access) (*). They are not separate checkboxes on API Keys.

Connectors

ToolPurposeDomain scope
tealfabric_list_connectorsList connectors, or pass action get or parameters with connector_idconnectors.read
tealfabric_get_connector_oauth2_requiredReport whether connector_id requires OAuth2. An unknown connector_id is not foundconnectors.read
tealfabric_test_connectorTest connector_id with an optional configuration objectconnectors.write

Integrations

ToolPurposeDomain scope
tealfabric_list_integrationsList integrations. Optional action: get, statistics, status, execution-history. This tool does not test or run an integrationintegrations.read
tealfabric_create_integrationCreate an integration. type is api, webhook, message_queue, file_transfer, database, email, sms, or otherintegrations.write
tealfabric_update_integrationUpdate an integration by integration_idintegrations.write
tealfabric_execute_integrationRun integration_id with optional data. Set async to true to enqueue the runintegrations.execute
tealfabric_delete_integrationDelete an integration by integration_idintegrations.delete

status on create and update is active, inactive, error, or testing. configuration and connector_configuration are the same connector settings object.

WebApps

ToolPurposeDomain scope
tealfabric_list_webappsList WebApps. Rows omit page HTML, CSS, and JavaScript. tealfabric_get_webapp returns that contentwebapps.read
tealfabric_get_webappRead one WebApp. The response is the WebApp record and does not include an execution tokenwebapps.read
tealfabric_create_webappCreate a WebAppwebapps.write
tealfabric_update_webappUpdate a WebAppwebapps.write
tealfabric_publish_webappPublish a WebAppwebapps.write
tealfabric_unpublish_webappUnpublish a WebAppwebapps.write
tealfabric_create_webapp_versionStore a new versionwebapps.write
tealfabric_delete_webappDelete a WebAppwebapps.write

type is webapp, webhook, websocket, callback, document-viewer, or document_viewer.

ProcessFlow

ToolPurposeDomain scope
tealfabric_list_processesList processes in the key’s workspace. Optional limit (default 50, max 200) and offsetprocessflow.read
tealfabric_get_processRead one process by process_id, including its steps. Step configuration omits runtime_compiledprocessflow.read
tealfabric_list_process_stepsList steps for process_id. An unknown process is not found. Step configuration omits runtime_compiledprocessflow.read
tealfabric_get_process_stepRead one step by step_idprocessflow.read
tealfabric_execute_processRun process_id with an optional input objectprocessflow.execute
tealfabric_create_processCreate a process. Returns process_id. Default status is draftprocessflow.write
tealfabric_update_processUpdate a processprocessflow.write
tealfabric_retire_processSet status to inactive and prefix the name with <retired>processflow.read and processflow.write
tealfabric_delete_processDelete a process by process_idprocessflow.write
tealfabric_create_process_stepAdd a step. Requires name or step_name. Returns step_idprocessflow.write
tealfabric_update_process_stepUpdate a step by step_idprocessflow.write
tealfabric_delete_process_stepDelete a step by step_idprocessflow.write

Process status is draft, active, inactive, or archived. Step language is javascript or typescript. tealfabric_retire_process reads the process and then updates it, so the key needs both read and write.

Documents

Paths are workspace document paths, such as packages/report.md. They are not URLs. List and tree omit .keystore and .cache. Those paths are reserved and cannot be read, written, moved, or deleted through these tools. .todo and .trash stay visible. A missing directory is not found. Markdown downloads use text/markdown.

ToolPurposeDomain scope
tealfabric_list_documentsList a directory. path empty lists the rootdocuments.read
tealfabric_list_document_treeList a directory as a tree. max_depth is 1–8 and defaults to 3documents.read
tealfabric_get_document_metadataMetadata for file_pathdocuments.read
tealfabric_read_document_textRead a UTF-8 text file at file_pathdocuments.read
tealfabric_download_documentDownload a file. Content is returned as base64documents.read
tealfabric_write_document_textWrite UTF-8 content to file_path and keep a backup. encoding, when set, is utf8 or utf-8documents.write
tealfabric_upload_documentUpload a file from a local file_path into destination_path. The stored name is the file’s namedocuments.write
tealfabric_move_documentMove or rename old_path to new_pathdocuments.write
tealfabric_delete_documentDelete a file or directory at pathdocuments.write

tealfabric_upload_document reads file_path on the computer running the MCP process. With the hosted server at /mcp, that computer is the API host, so a path on your laptop does not upload. Use tealfabric_write_document_text for UTF-8 text from a remote agent, or run the local program tealfabric-mcp-server on the machine that has the file. See Connect external agents with the MCP server.

See also