View this page in the latest version of Appian. MCP System Tools Share Share via LinkedIn Reddit Email Copy Link Print On This Page This page is for system administrators, developers, and end users. It describes the system-level Model Context Protocol (MCP) tools provided by Appian MCP Server out of the box. How system tools work with developer-enabled tools Appian MCP Server provides two categories of Model Context Protocol (MCP) tools: System tools provide discovery and data access. System tools let external AI applications find available tools, retrieve schemas, invoke design objects, and query your data fabric. Developer-enabled tools provide business logic. Developers make process models, expression rules, and Appian AI agents available through MCP. For enablement instructions, see Make Design Objects Available as MCP Tools. System tools and developer-enabled tools work together. The AI application uses system tools to discover and invoke developer-enabled tools. Generic tools Generic Model Context Protocol (MCP) tools handle discovery and invocation of developer-enabled design objects. These tools form the core workflow for interacting with Appian business logic through MCP. appian_search_tools Search for design objects that are available as MCP tools. Property Value Tool Description Search for available MCP tools by keyword. Returns tool names, descriptions, and types matching the search query. Permissions required Authenticated user. Results filtered by object security and group membership. Inputs: Name Type Required Description query Text Yes A keyword or phrase describing the capability you are looking for. Outputs: Name Type Description tools List of Map A list of matching tools with name, description, type, and identifier for each. Limitations: Results only include tools the authenticated user has permission to access. appian_get_tool_schema Get the full input and output schema for a specific design object enabled as an MCP tool. Property Value Tool Description Retrieve the complete input and output schema for a specific MCP tool, including parameter names, types, required/optional designations, and nested field definitions. Permissions required Authenticated user must have viewer access to the design object. Inputs: Name Type Required Description toolId Text Yes The unique identifier of the MCP tool returned by appian_search_tools. Outputs: Name Type Description schema Map The full input and output schema for the tool, including parameter definitions and data types. appian_invoke_process_model Start a process model that has been made available as an MCP tool and wait for completion. Property Value Tool Description Invoke a process model with the provided input parameters. The tool starts the process and waits for it to reach a terminal node. Permissions required Authenticated user must have viewer access to the process model and must be an allowed initiator. Inputs: Name Type Required Description toolId Text Yes The unique identifier of the MCP-enabled process model. inputs Map No A map of input parameter names to values, matching the process model's input variables. Outputs: Name Type Description processId Number (Integer) The ID of the process instance that was started. status Text The completion status of the process. outputs Map The output values from the completed process, if any. Limitations: Process models with start forms or synchronous user input tasks stall until timeout. Design process models for MCP invocation without UI-dependent steps. appian_get_process_status Check the status of a running or completed process instance started through MCP. Property Value Tool Description Retrieve the current status of a process instance, including whether it is running, completed, or failed. Permissions required Authenticated user must have viewer access to the process model. Inputs: Name Type Required Description processId Number (Integer) Yes The process instance ID returned by appian_invoke_process_model. Outputs: Name Type Description status Text The current status of the process instance (running, completed, failed, or cancelled). outputs Map The output values from the process, if completed. appian_invoke_expression_rule Evaluate an expression rule that has been made available as an MCP tool with provided inputs. Property Value Tool Description Invoke an expression rule with the provided input parameters and return the result. Permissions required Authenticated user must have viewer access to the expression rule. Inputs: Name Type Required Description toolId Text Yes The unique identifier of the MCP-enabled expression rule. inputs Map No A map of input parameter names to values, matching the expression rule's inputs. Outputs: Name Type Description result Any Type The return value of the expression rule evaluation. Limitations: If the expression rule queries objects the authenticated user lacks access to, the rule succeeds but returns null for inaccessible data. appian_invoke_agent Invoke an Appian AI agent that has been made available as an MCP tool with a message. Property Value Tool Description Send a prompt to an Appian AI agent and receive the response. The interaction is single-turn. ◊ Permissions required Authenticated user must be on the role map for the AI agent and all of its underlying tools. Inputs: Name Type Required Description toolId Text Yes The unique identifier of the MCP-enabled AI agent. message Text Yes The natural language prompt to send to the AI agent. Outputs: Name Type Description invocationId Text The unique identifier for this agent invocation. response Text The AI agent's response to the prompt. status Text The completion status of the agent invocation. Limitations: Multi-turn conversations are not supported through MCP. Each invocation is a single prompt and response. appian_get_agent_status Check whether an AI agent started through MCP is still running or has finished. While the AI agent runs, the response also returns summaries of the steps it has completed and a hint for how soon to request status again. Property Value Tool Description Retrieve the current status of an AI agent invocation, including whether it is pending, running, completed, failed, or stopped. While the agent is running, the response also includes summaries of the steps completed so far and a hint for how soon to poll again. Permissions required Authenticated user must be on the role map for the AI agent. Inputs: Name Type Required Description invocationId Text Yes The invocation ID returned by appian_invoke_agent. Outputs: Name Type Description invocationId Text The unique identifier of the AI agent invocation, matching the invocationId passed to appian_get_agent_status. status Text The current status of the AI agent. Possible values are "PENDING", "RUNNING", "COMPLETED", "FAILED", and "STOPPED". startedAt Date and Time The date and time when the AI agent invocation started, in ISO 8601 format. numToolCalls Number (Integer) The number of tool calls the AI agent has completed so far. response Text The AI agent's response, if completed. steps List of Map Summaries of the steps the AI agent has completed so far. Each entry includes the step index, a summary of what the step did or found, and a timestamp. Present only while the AI agent is pending or running, and only after at least one step has completed. nextPollHint Map A recommended delay before the next status request. Contains pollAfterMs, the number of milliseconds to wait. Present only while the AI agent is pending or running. Step summaries returned during execution While an AI agent is pending or running, the steps output returns the history of steps the AI agent has completed so far. Each entry summarizes what the AI agent found or did at that step, such as "Searching for Q2 support cases…", "Found 47 cases. Analyzing by category…", or "Top issues: VPN connectivity (7), password resets (5), SSO lockouts (4)". The AI agent platform produces these summaries as it works, so they require no extra processing. A step summary describes the result of a step at a high level. It does not include tool inputs, query parameters, raw returned records, or the AI agent's internal reasoning. This lets an AI application show what the AI agent is working on without surfacing query details or sensitive data. Before the AI agent completes its first step, the steps output is absent from the response, even though the status is already "PENDING" or "RUNNING". The nextPollHint output, by contrast, is present throughout the pending and running states. Each summary is limited to 500 characters. A single response returns at most 20 step summaries and shows the most recent steps. When the first index in the steps list is greater than 0, earlier steps were truncated from the response. Adaptive polling with nextPollHint The nextPollHint output tells the AI application how soon to request status again through its pollAfterMs value. Appian sets this value based on how recently the AI agent completed a step: 2000 (poll again after two seconds): The AI agent completed a step within the last five seconds, so it is actively working and new progress is likely soon. 5000 (poll again after five seconds): No steps have completed yet, or the last step completed more than five seconds ago, which suggests the AI agent is waiting on a longer operation. An AI application should poll appian_get_agent_status at intervals of five seconds or less while the AI agent is running. Example enriched status response The following response shows an AI agent that is still running. The steps list contains the completed step summaries, and nextPollHint recommends requesting status again in two seconds: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 { "status": "RUNNING", "invocationId": "a1b2c3d4-5e6f-7890-abcd-ef1234567890", "startedAt": "2026-08-17T14:32:00Z", "numToolCalls": 3, "steps": [ { "index": 0, "summary": "Searching for Q2 support cases...", "timestamp": "2026-08-17T14:32:14Z" }, { "index": 1, "summary": "Found 47 cases. Analyzing by category...", "timestamp": "2026-08-17T14:32:17Z" }, { "index": 2, "summary": "Top issues: VPN connectivity (7), password resets (5), SSO lockouts (4)", "timestamp": "2026-08-17T14:32:28Z" } ], "nextPollHint": { "pollAfterMs": 2000 } } Note: The steps and nextPollHint outputs are additive and appear only while the AI agent is pending or running. They are absent from "COMPLETED", "FAILED", and "STOPPED" responses, so existing AI applications that poll for the final result are unaffected and need no configuration. Limitations: Step summaries and polling hints are available only when an AI agent is started with appian_invoke_agent. Process models started with appian_invoke_process_model do not return step summaries. Data fabric tools The Query Data Fabric tool collection provides access to synced record types that are published for analytics and AI. System administrators enable or disable the collection in the Admin Console. Data fabric tools identify record types by their SQL reference name. Appian automatically generates a SQL reference name for each record type, and developers can edit the SQL reference name in the record type's properties. AI applications use the SQL reference name as the table identifier when constructing queries against the data fabric. Note: The data fabric tools documented in this section are also available as part of the Query Records system tool within Appian AI agents, using the same SQL API infrastructure and security enforcement. For details on how AI agents query data, see Querying Record Data. appian_data_fabric_metadata Get available record types, fields, and relationships in the data fabric to understand which data to query. This tool provides both keyword search and semantic search options to the AI agent to explore the data model available. Property Value Tool Description Retrieve metadata about available record types using keyword or semantic search. Matches a search query against record type names, descriptions, and fields using exact keyword matching or semantic similarity to surface the most relevant record types. Permissions required Authenticated user must have at least Viewer permission to a record type to view its metadata. Field-level security is also applied. Inputs: Name Type Required Description recordType Text No If provided, returns metadata for a specific record type. If omitted, returns a list of all synced record types. searchQuery Text No If provided, uses keyword matching or semantic search to match the query against record type names, descriptions, and fields. If omitted, returns a list of all synced record types. Outputs: Name Type Description recordTypes List of Map A list of record type definitions including their name, SQL reference name, description, fields (with data type, description, primary key status, and whether smart search is enabled), and relationships. When a searchQuery is provided, results are ranked by relevance. similarityScore Number (Decimal Floating) A decimal value between 0 and 1 that indicates how closely a record type matches the search. A score of 1 represents the highest level of semantic similarity. Only included when a semantic search occurs on the record type metadata. appian_data_fabric_sql_query Query record data using SQL syntax. Property Value Tool Description Execute a SQL query against Appian record data. Returns results filtered by record-level security and field-level security. Permissions required Authenticated user must have at least Viewer permission to the record type. Results are further filtered by record-level security and field-level security. Inputs: Name Type Required Description query Text Yes A SQL query string targeting synced record types. The SQL reference name configured on the record type is used as the table name in the query. For fields with smart search enabled, the AI agent can perform semantic or lexical searches on record data and receive results ranked by similarity score. The metadata tool indicates which fields are enabled for smart search. Outputs: Name Type Description results List of Map The query results as a list of records, with each record containing field name/value pairs. rowCount Number (Integer) The number of rows returned. Limitations: Appian MCP Server cannot query the following record types: Unsynced record types. Legacy record types. Record types with record-level security expressions. Replace the security expression with security rules to query the record data. Process HQ tools The Analyze Business Processes tool collection lets AI applications query, analyze, and build reports for business processes and record data in Process HQ. System administrators enable or disable the collection in the Admin Console. appian_data_catalog_metadata Discover record types available for reporting, filtered by data catalog visibility. This tool returns only the record types that are published for analytics and AI. Property Value Tool Description Retrieve record types available for reporting in Process HQ. Returns record type names, fields, data types, and relationships, filtered by data catalog governance rules. Use this tool to identify available data sources before creating a report. Permissions required Authenticated user must have at least Viewer permission to a record type. Field-level security is also applied. Inputs: Name Type Required Description searchQuery Text No A keyword or phrase to filter record types by name or description. If omitted, returns all record types visible in the data catalog. Output: A text response listing available record types with their names, fields, data types, and relationships. appian_create_report Create a new report in Process HQ from a dataset. The report is persisted immediately and the tool returns the report name and a link to open it. Property Value Tool Description Create a new report in Process HQ backed by a dataset. Accepts a structured configuration including data source, columns, chart type, groupings, and measures. The report is persisted and the tool returns the report name and a link to open it. Supported report designs include dataset report designs and general report designs. Permissions required Authenticated user must be a Data Fabric Report Creators. Inputs: Name Type Required Description name Text Yes The name of the report. dataSource Text Yes The record type to use as the report's data source, identified by the reference returned by appian_data_catalog_metadata. chartType Text Yes The chart type for the report visualization. Valid values: "GRID", "BAR", "COLUMN", "LINE", "AREA", "PIE", "SCATTER", "KPI", "HEATMAP". columns List of Map Yes Column definitions for the report, including field references from the data source. dataConfig Map No Data configuration including groupings, measures, and sort order. Chart-type-specific constraints apply—for example, a pie chart requires exactly one grouping and one measure. Output: A text response with the name of the created report and a link to open it in Process HQ. Limitations: This tool only creates reports from datasets. Process-backed reports are not supported. Reports are persisted immediately on creation. There is no draft or preview state. If the report configuration is invalid, the tool returns a descriptive error that the AI application can use to retry with corrected parameters. appian_list_business_processes List all business processes available in the environment. Property Value Tool Description List all business processes available in the environment. Returns the Appian ID for each process, which you can use to reference a specific process in other tools. Permissions required Authenticated user must have at least viewer permission to the record type. Inputs: Name Type Required Description name Text No A keyword or phrase to filter processes by name. Output: A text response listing the available business processes with their names, descriptions, and Appian IDs. appian_get_business_process Get detailed information about a specific business process. Property Value Tool Description Retrieve detailed metadata about a specific business process, including datasets, filters, and schedule configuration. Permissions required Authenticated user must have viewer access to the business process. Inputs: Name Type Required Description appian_id Text Yes The Appian ID of the business process (returned by appian_list_business_processes). Output: A text response describing the business process metadata, including its datasets, filters, and sync schedule. appian_aggregate_business_process Query aggregated process metrics—case counts, durations, and activity frequencies. Property Value Tool Description Query aggregated process metrics. Use this tool to analyze case counts, measure durations, and identify activity patterns. Permissions required Authenticated user must have viewer access to the business process. Inputs: Name Type Required Description appian_id Text Yes The Appian ID of the business process (returned by appian_list_business_processes). aggregations Text Yes A description of what to measure and how to group the results. Output: A text response with the aggregated metrics, such as case counts, average durations, or activity frequencies. appian_explore_attributes Explore which attribute values correlate with longer or shorter durations. Property Value Tool Description Explore attribute value distributions scored by a metric. Use this tool to identify which attribute values correlate with longer or shorter process durations. Permissions required Authenticated user must have viewer access to the business process. Inputs: Name Type Required Description appian_id Text Yes The Appian ID of the business process (returned by appian_list_business_processes). metric Text Yes The metric to score by (for example, average duration or median duration). Output: A text response listing attribute values and how they correlate with the specified metric. appian_discover_cases Discover individual cases matching specific criteria. Property Value Tool Description Discover individual cases (process instances) matching criteria. Use this tool after identifying patterns with aggregation to drill down into specific cases. Permissions required Authenticated user must have viewer access to the business process. Inputs: Name Type Required Description appian_id Text Yes The Appian ID of the business process (returned by appian_list_business_processes). filters Text No Criteria to filter which cases to return. Output: A text response listing the matching cases with their IDs and names. appian_discover_events_in_case Retrieve the ordered sequence of events within specific cases. Property Value Tool Description Retrieve the ordered sequence of events within specific cases. Use this tool to examine the detailed event trail for cases found with appian_discover_cases. Permissions required Authenticated user must have viewer access to the business process. Inputs: Name Type Required Description appian_id Text Yes The Appian ID of the business process (returned by appian_list_business_processes). caseIds Text Yes The case IDs to retrieve events for (returned by appian_discover_cases). Output: A text response listing the ordered sequence of events for each case, including activity names and timestamps. appian_get_filter_reference Get the filter schema reference to understand how to filter process data. Property Value Tool Description Return the complete filter schema reference for process insights tools. Call this tool to understand filter structure before using filters in other tools. Permissions required Authenticated user. Inputs: Name Type Required Description reasoning Text No A description of why you need the filter reference. Output: A text response documenting all available filter types with schemas and examples. appian_start_insights Start an asynchronous root cause analysis for a business process KPI. Returns a job ID that you use to poll for results with appian_get_insights_status. Property Value Tool Description Start insight generation for a business process KPI. Discovers multi-factor explanations of what drives a KPI to underperform, such as attribute values, activities, or sequences that correlate with worse outcomes. Returns a job ID immediately. Permissions required Authenticated user must have viewer access to the business process. Inputs: Name Type Required Description appian_id Text Yes The Appian ID of the business process (returned by appian_list_business_processes). metric Text Yes The KPI to analyze, such as case frequency or average duration. scope Text No The scope of analysis: all cases, all events, a specific event, or a specific sequence. filters Text No A filter set to narrow the case population. Use appian_get_filter_reference to understand filter structure. attributeNamesToExclude Text No Attributes to exclude from insight generation to redirect exploration to alternative factors. Output: A job ID string to use with appian_get_insights_status. appian_get_insights_status Poll the status of an insight generation job started by appian_start_insights. Property Value Tool Description Retrieve the status and results of an insight generation job. Returns the job status and, when complete, the ranked insights showing which factor combinations have the highest impact on the KPI. Permissions required Authenticated user must have viewer access to the business process. Inputs: Name Type Required Description appian_id Text Yes The Appian ID of the business process used in appian_start_insights. job_id Text Yes The job ID returned by appian_start_insights. limit Number (Integer) No Maximum number of insights to return per KPI. Defaults to 5. Output: A text response with the job status and, when complete, a ranked list of insights. Each insight includes the contributing factors, their impact score, and the number of affected cases. appian_get_recommendations_reference Get Appian-specific remediation guidance for common process issues. Property Value Tool Description Return structured remediation guidance for common process issues, categorized by issue type. Use this tool after identifying problems with other process insights tools to understand what Appian-specific actions can address them. Permissions required Authenticated user. Inputs: Name Type Required Description reasoning Text No A description of why you need the recommendations reference. Output: A text response with categorized remediation guidance for common process issues such as long durations, rework loops, SLA violations, and unbalanced workloads. appian_model_statistics Get the full process model with activity and sequence performance statistics. Property Value Tool Description Retrieve the complete process model with frequency counts and duration statistics for all activities and sequences. Use this tool to identify structural bottlenecks, find the slowest activities, and understand where time is spent across the process. Permissions required Authenticated user must have viewer access to the business process. Inputs: Name Type Required Description appian_id Text Yes The Appian ID of the business process (returned by appian_list_business_processes). edgeThreshold Number (Decimal Floating) No Controls which sequences are included, from 0.0 to 1.0. Higher values return more sequences. Defaults to 0.2. filters Text No A filter set to scope results to a subset of cases. Use appian_get_filter_reference to understand filter structure. maxFollowers Number (Integer) No Maximum number of direct sequences to return. Output: A text response with per-activity duration statistics, per-sequence wait time statistics, and global extrema across all activities. End-to-end examples The following examples show how an AI application chains Model Context Protocol (MCP) system tools together to answer a user's question or complete a task. Query data with system tools This example uses data fabric tools to find and query record data: A user asks their AI application: How many open support cases about connectivity issues are assigned to the West region? The AI application calls appian_data_fabric_metadata to discover available record types and finds a "Support Case" record type with fields for status, region, and a description field with smartSearchEnabled set to true. The AI application calls appian_data_fabric_sql_query with a SQL query that uses smart search to semantically search the description field for "connectivity issues," filtered to open cases in the West region. The AI application receives the filtered results (respecting all record type security) and returns the count to the user. Invoke developer-enabled tools This example uses generic tools to discover and invoke a developer-enabled expression rule: A user asks their AI application: Calculate the discount for order 12345. The AI application calls appian_search_tools with the query "calculate discount" and finds an MCP-enabled expression rule called "Calculate Order Discount." The AI application calls appian_get_tool_schema to retrieve the input schema (order ID as a required input). The AI application calls appian_invoke_expression_rule with the order ID. The AI application receives the calculated discount value and returns it to the user. Create a report in Process HQ This example uses Process HQ tools to discover a data source and create a report from a dataset: A user asks their AI application: Create a bar chart of average cycle time by region. The AI application calls appian_data_catalog_metadata to discover record types the user can report on and finds a record type with fields for cycle time and region. The AI application calls appian_create_report with a structured report configuration that specifies the data source, a bar chart type, cycle time as the measure, and region as the grouping. The report is persisted in Process HQ. The AI application receives the report name and a link, which it returns to the user. Feedback Was this page helpful? SHARE FEEDBACK Loading...