Effivity MCP Server Documentation

Effivity MCP Server Documentation

Connect MCP-compatible AI clients to authorized Effivity workflows, forms, records, FAQs, and support services.

Overview

The Effivity MCP Server provides a secure interface for MCP-compatible clients to interact with authorized Effivity services and data.

Access is controlled using the authenticated Effivity user's tenant, identity, roles, workflow permissions, and applicable record-level permissions.

Server URL

Use the following remote MCP server endpoint:

https://effivity-ne-mcpserver.azurewebsites.net/mcp

Authentication

The Effivity MCP Server uses OAuth 2.0 authorization code flow.

Users authenticate using their Effivity tenant or domain, username, and password through the Effivity authentication flow.

Authentication does not grant additional privileges beyond the user's existing Effivity permissions.

Available Tools

The server exposes seven tools: six read-only tools and one write tool. The exact data returned by each tool depends on the authenticated user's Effivity permissions.

Read-only tools

  • READ

    List Workflow Masters

    list_workflow_masters

    Lists the workflow masters (screens or modules) available to the authenticated user, with their ID, name, code, and status. Results can be narrowed with an optional name filter, for example "Risk" or "Incident".

  • READ

    Get Workflow Master

    get_workflow_master

    Retrieves details for a specific authorized workflow master, including its form schema, available views, columns, and configuration.

  • READ

    Get Workflow Forms

    get_workflow_forms

    Retrieves the forms and workflow configuration needed to start a new process in a workflow master, including the form schema and the actions available to the user.

  • READ

    Get Column Metadata

    get_column_metadata

    Retrieves configuration for selected columns in a workflow view, including their available values and filter instructions. Used to build accurate filters before listing records.

  • READ

    List Form Data

    list_form_data

    Retrieves paged records from an authorized workflow view. Supports field selection, filters, count-only queries, and optional inclusion of draft or archived records, which are excluded by default.

  • READ

    Ask FAQ

    ask_faq

    Searches the Effivity FAQ knowledge base using retrieval-augmented generation and returns answers about the Effivity application, with links to the source articles.

Write tools

  • WRITE

    Create Support Ticket

    create_support_ticket

    Creates an Effivity support ticket using a title and description supplied by the authenticated user. The related module and a ticket category (Configuration, Change Request, Technical Functionality, Focused Training, or Bug) can optionally be included. Returns a success or error message.

Authorization & Permissions

Effivity MCP access follows the permissions assigned to the authenticated Effivity user.

  • Access is limited to the authenticated Effivity tenant.
  • Existing role and workflow permissions are respected.
  • Record-level access restrictions continue to apply.
  • The MCP connector does not grant additional application permissions.
  • Users cannot use the MCP connector to bypass Effivity access controls.

Security

  • Connections to the MCP server use HTTPS.
  • Authentication is performed using OAuth 2.0.
  • Tenant context is validated for authenticated requests.
  • Existing Effivity authorization rules are applied when accessing workflows and records.
  • The connector communicates with Effivity first-party APIs.

Data Handling

The Effivity MCP Server accesses Effivity data only when required to execute a user-requested tool operation.

  • Access is restricted to the authenticated Effivity tenant.
  • Existing Effivity user and role permissions are respected.
  • Data is retrieved or updated using authorized Effivity first-party APIs.
  • The MCP connector does not provide unrestricted access to the underlying Effivity database.
  • Draft and archived records are excluded from record listings unless explicitly requested.
  • The only write operation is support ticket creation. The connector does not create, modify, or delete workflow records or form data.
Effivity tenant and user authorization remains applicable throughout MCP requests.

Connection Details

Transport Remote MCP over HTTPS
Authentication OAuth 2.0 authorization code flow
Authorization Effivity tenant, user, role, workflow, and record permissions
Tools 7 (6 read-only, 1 write)
MCP endpoint https://effivity-ne-mcpserver.azurewebsites.net/mcp

Policies & Support

Support email techsupport@effivity.com

Technical Support

For questions related to MCP connectivity, authentication, permissions, or Effivity tool behavior, contact:

techsupport@effivity.com