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
| Field | Value |
|---|---|
| Canonical URL | /docs/07_ai-agents-and-mcp/33_mcp-server-tool-reference |
| Version (published date) | 2026-11-13 |
| Tags | mcp, mcp-server, tools, reference |
How calls behave
tools/listreturns this set for any key that hasmcp.readormcp.write. Listing tools does not require a platform skill.tools/callrequiresmcp.writeand the domain scope in the table for that tool.- The workspace is the API key’s workspace. Document tools accept an optional
tenant_idand 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
| Tool | Purpose | Domain scope |
|---|---|---|
tealfabric_list_connectors | List connectors, or pass action get or parameters with connector_id | connectors.read |
tealfabric_get_connector_oauth2_required | Report whether connector_id requires OAuth2. An unknown connector_id is not found | connectors.read |
tealfabric_test_connector | Test connector_id with an optional configuration object | connectors.write |
Integrations
| Tool | Purpose | Domain scope |
|---|---|---|
tealfabric_list_integrations | List integrations. Optional action: get, statistics, status, execution-history. This tool does not test or run an integration | integrations.read |
tealfabric_create_integration | Create an integration. type is api, webhook, message_queue, file_transfer, database, email, sms, or other | integrations.write |
tealfabric_update_integration | Update an integration by integration_id | integrations.write |
tealfabric_execute_integration | Run integration_id with optional data. Set async to true to enqueue the run | integrations.execute |
tealfabric_delete_integration | Delete an integration by integration_id | integrations.delete |
status on create and update is active, inactive, error, or testing. configuration and connector_configuration are the same connector settings object.
WebApps
| Tool | Purpose | Domain scope |
|---|---|---|
tealfabric_list_webapps | List WebApps. Rows omit page HTML, CSS, and JavaScript. tealfabric_get_webapp returns that content | webapps.read |
tealfabric_get_webapp | Read one WebApp. The response is the WebApp record and does not include an execution token | webapps.read |
tealfabric_create_webapp | Create a WebApp | webapps.write |
tealfabric_update_webapp | Update a WebApp | webapps.write |
tealfabric_publish_webapp | Publish a WebApp | webapps.write |
tealfabric_unpublish_webapp | Unpublish a WebApp | webapps.write |
tealfabric_create_webapp_version | Store a new version | webapps.write |
tealfabric_delete_webapp | Delete a WebApp | webapps.write |
type is webapp, webhook, websocket, callback, document-viewer, or document_viewer.
ProcessFlow
| Tool | Purpose | Domain scope |
|---|---|---|
tealfabric_list_processes | List processes in the key’s workspace. Optional limit (default 50, max 200) and offset | processflow.read |
tealfabric_get_process | Read one process by process_id, including its steps. Step configuration omits runtime_compiled | processflow.read |
tealfabric_list_process_steps | List steps for process_id. An unknown process is not found. Step configuration omits runtime_compiled | processflow.read |
tealfabric_get_process_step | Read one step by step_id | processflow.read |
tealfabric_execute_process | Run process_id with an optional input object | processflow.execute |
tealfabric_create_process | Create a process. Returns process_id. Default status is draft | processflow.write |
tealfabric_update_process | Update a process | processflow.write |
tealfabric_retire_process | Set status to inactive and prefix the name with <retired> | processflow.read and processflow.write |
tealfabric_delete_process | Delete a process by process_id | processflow.write |
tealfabric_create_process_step | Add a step. Requires name or step_name. Returns step_id | processflow.write |
tealfabric_update_process_step | Update a step by step_id | processflow.write |
tealfabric_delete_process_step | Delete a step by step_id | processflow.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.
| Tool | Purpose | Domain scope |
|---|---|---|
tealfabric_list_documents | List a directory. path empty lists the root | documents.read |
tealfabric_list_document_tree | List a directory as a tree. max_depth is 1–8 and defaults to 3 | documents.read |
tealfabric_get_document_metadata | Metadata for file_path | documents.read |
tealfabric_read_document_text | Read a UTF-8 text file at file_path | documents.read |
tealfabric_download_document | Download a file. Content is returned as base64 | documents.read |
tealfabric_write_document_text | Write UTF-8 content to file_path and keep a backup. encoding, when set, is utf8 or utf-8 | documents.write |
tealfabric_upload_document | Upload a file from a local file_path into destination_path. The stored name is the file’s name | documents.write |
tealfabric_move_document | Move or rename old_path to new_path | documents.write |
tealfabric_delete_document | Delete a file or directory at path | documents.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
- Connect external agents with the MCP server
- MCP tool catalog (Trace AI and platform skills)
- API key management