Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Affinda MCP connector

AI-powered document processing platform that extracts, validates, and integrates structured data from invoices, resumes, contracts, and custom document...

  1. Install the SDK

    Section titled “Install the SDK”
    Terminal window
    npm install @scalekit-sdk/node

    Full SDK reference: Node.js | Python

  2. Set your credentials

    Section titled “Set your credentials”

    Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

    .env
    SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
    SCALEKIT_CLIENT_ID=<your-client-id>
    SCALEKIT_CLIENT_SECRET=<your-client-secret>

  3. Authorize and make your first call

    Section titled “Authorize and make your first call”
    quickstart.ts
    import { ScalekitClient } from '@scalekit-sdk/node'
    import 'dotenv/config'
    

    const scalekit = new ScalekitClient(
      process.env.SCALEKIT_ENV_URL,
      process.env.SCALEKIT_CLIENT_ID,
      process.env.SCALEKIT_CLIENT_SECRET,
    )
    const actions = scalekit.actions
    

    const connector = 'affindamcp'
    const identifier = 'user_123'
    

    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize Affinda MCP:', link)
    process.stdout.write('Press Enter after authorizing...')
    await new Promise(r => process.stdin.once('data', r))
    

    // Make your first call
    const result = await actions.executeTool({
      connector,
      identifier,
      toolName: 'affindamcp_list_organizations',
      toolInput: {},
    })
    console.log(result)

What you can do

Section titled “What you can do”

Connect this agent connector to let your agent:

  • Processing wait for document — Block until every document in a workspace has finished processing
  • Update workspace, validation rule, organization — Update one or more settings on an existing workspace
  • Connection test — Verify a service connection’s credentials are still valid
  • Secret set integration — Create or update a secret on an integration
  • Run integration — Execute an integration against one document as a test run
  • Version revert integration, deploy integration — Roll an integration back to a previous version and redeploy it

Tool list

Section titled “Tool list”

Use the exact tool names from the Tool list below when you call execute_tool. If you’re not sure which name to use, list the tools available for the current user first.

affindamcp_add_connection_to_integration#Attach an existing service connection to an integration.2 params

Attach an existing service connection to an integration.

NameTypeRequiredDescription
connection_idstringrequiredNo description.
integration_idstringrequiredNo description.
affindamcp_archive_documents#Move documents to ``archived`` state.1 param

Move documents to ``archived`` state.

NameTypeRequiredDescription
document_idsarrayrequiredNo description.
affindamcp_assign_document_type_to_workspace#Make a document type available for use in a workspace.2 params

Make a document type available for use in a workspace.

NameTypeRequiredDescription
document_type_idstringrequiredNo description.
workspace_idstringrequiredNo description.
affindamcp_bulk_create_data_source_values#Append many new rows to a data source in one call.2 params

Append many new rows to a data source in one call.

NameTypeRequiredDescription
data_source_idstringrequiredNo description.
valuesarrayrequiredNo description.
affindamcp_bulk_create_fields#Create many fields on a document type in one call.3 params

Create many fields on a document type in one call.

NameTypeRequiredDescription
document_type_idstringrequiredNo description.
fieldsarrayrequiredNo description.
field_group_idstringoptionalNo description.
affindamcp_confirm_documents#Mark documents as validated, moving them from ``review`` to ``validated``.1 param

Mark documents as validated, moving them from ``review`` to ``validated``.

NameTypeRequiredDescription
document_idsarrayrequiredNo description.
affindamcp_create_api_token#Create a new long-lived Affinda API key for the current user.0 params

Create a new long-lived Affinda API key for the current user.

affindamcp_create_connect_token#Mint an OAuth connect token + URL so the user can authorise a service.1 param

Mint an OAuth connect token + URL so the user can authorise a service.

NameTypeRequiredDescription
connection_idstringrequiredNo description.
affindamcp_create_data_source#Create an empty data source (lookup table) in an organization.5 params

Create an empty data source (lookup table) in an organization.

NameTypeRequiredDescription
namestringrequiredNo description.
organization_idstringrequiredNo description.
display_propertystringoptionalNo description.
key_propertystringoptionalNo description.
schema_definitionstringoptionalNo description.
affindamcp_create_data_source_value#Add one new row to a data source.2 params

Add one new row to a data source.

NameTypeRequiredDescription
data_source_idstringrequiredNo description.
valuestringrequiredNo description.
affindamcp_create_document_type#Create a new document type (extraction template) in an organization.3 params

Create a new document type (extraction template) in an organization.

NameTypeRequiredDescription
namestringrequiredNo description.
organization_idstringrequiredNo description.
disable_confirmation_if_validation_rules_failbooleanoptionalNo description.
affindamcp_create_field#Create a single field on a document type.15 params

Create a single field on a document type.

NameTypeRequiredDescription
document_type_idstringrequiredNo description.
field_typestringrequiredNo description.
labelstringrequiredNo description.
slugstringrequiredNo description.
decimal_placesstringoptionalNo description.
descriptionstringoptionalNo description.
enabledbooleanoptionalNo description.
field_group_idstringoptionalNo description.
manual_entrybooleanoptionalNo description.
mapping_data_source_idstringoptionalNo description.
multiplebooleanoptionalNo description.
no_rectbooleanoptionalNo description.
optionsstringoptionalNo description.
parent_idstringoptionalNo description.
transformation_promptstringoptionalNo description.
affindamcp_create_field_group#Create a field group (heading/section) on a document type.2 params

Create a field group (heading/section) on a document type.

NameTypeRequiredDescription
document_type_idstringrequiredNo description.
labelstringrequiredNo description.
affindamcp_create_integration#Create a new, empty integration in an organization.3 params

Create a new, empty integration in an organization.

NameTypeRequiredDescription
namestringrequiredNo description.
organization_idstringrequiredNo description.
descriptionstringoptionalNo description.
affindamcp_create_matching_criterion#Add a matching criterion to a field with an attached data source.7 params

Add a matching criterion to a field with an attached data source.

NameTypeRequiredDescription
data_source_propertystringrequiredNo description.
field_idstringrequiredNo description.
source_field_idstringrequiredNo description.
field_attributestringoptionalNo description.
match_typestringoptionalNo description.
requiredbooleanoptionalNo description.
required_strictbooleanoptionalNo description.
affindamcp_create_recruit_workspace#Create a fully-configured Recruitment workspace in one call.1 param

Create a fully-configured Recruitment workspace in one call.

NameTypeRequiredDescription
organization_idstringrequiredNo description.
affindamcp_create_validation_rule#Create a validation rule for a document type.5 params

Create a validation rule for a document type.

NameTypeRequiredDescription
document_type_idstringrequiredNo description.
promptstringrequiredNo description.
enabledbooleanoptionalNo description.
field_idsstringoptionalNo description.
missing_data_optionstringoptionalNo description.
affindamcp_create_validation_run#Run a validation rule against a document and refresh its results.3 params

Run a validation rule against a document and refresh its results.

NameTypeRequiredDescription
validation_rule_idstringrequiredNo description.
document_idstringoptionalNo description.
document_type_idstringoptionalNo description.
affindamcp_create_workspace#Create a new workspace with chosen processing settings.9 params

Create a new workspace with chosen processing settings.

NameTypeRequiredDescription
namestringrequiredNo description.
organization_idstringrequiredNo description.
document_splitter_idstringoptionalNo description.
enable_document_classificationbooleanoptionalNo description.
enable_document_splittingbooleanoptionalNo description.
model_memory_strategystringoptionalNo description.
ocr_modestringoptionalNo description.
reject_duplicatesbooleanoptionalNo description.
visibilitystringoptionalNo description.
affindamcp_delete_data_source#Delete a data source and every row it contains.1 param

Delete a data source and every row it contains.

NameTypeRequiredDescription
data_source_idstringrequiredNo description.
affindamcp_delete_data_source_value#Delete one row from a data source by its key.2 params

Delete one row from a data source by its key.

NameTypeRequiredDescription
data_source_idstringrequiredNo description.
keystringrequiredNo description.
affindamcp_delete_document_type#Delete a document type permanently.2 params

Delete a document type permanently.

NameTypeRequiredDescription
document_type_idstringrequiredNo description.
delete_documentsbooleanoptionalNo description.
affindamcp_delete_field#Delete a single field from a document type.1 param

Delete a single field from a document type.

NameTypeRequiredDescription
field_idstringrequiredNo description.
affindamcp_delete_field_group#Delete a field group (heading/section) from a document type.1 param

Delete a field group (heading/section) from a document type.

NameTypeRequiredDescription
field_group_idstringrequiredNo description.
affindamcp_delete_integration#Permanently delete an integration.1 param

Permanently delete an integration.

NameTypeRequiredDescription
integration_idstringrequiredNo description.
affindamcp_delete_integration_secret#Permanently delete a secret. Removes both the database record and the Lambda environment variable.1 param

Permanently delete a secret. Removes both the database record and the Lambda environment variable.

NameTypeRequiredDescription
secret_idstringrequiredNo description.
affindamcp_delete_matching_criterion#Delete a matching criterion from a field.1 param

Delete a matching criterion from a field.

NameTypeRequiredDescription
matching_criterion_idstringrequiredNo description.
affindamcp_delete_validation_rule#Delete a validation rule from a document type.1 param

Delete a validation rule from a document type.

NameTypeRequiredDescription
validation_rule_idstringrequiredNo description.
affindamcp_deploy_integration_version#Snapshot the integration's current code as a new version and deploy it. Call this immediately after every successful ``update_integration`` that changed ``python_code`` — it MUST be the next tool call. Code saved on the integration is not live until deployed, and ``run_integration`` always executes the deployed version, so skipping this step means tests run stale code and real document events still fire the previous version. To roll back a bad deploy, use ``revert_integration_version`` wi...1 param

Snapshot the integration's current code as a new version and deploy it. Call this immediately after every successful ``update_integration`` that changed ``python_code`` — it MUST be the next tool call. Code saved on the integration is not live until deployed, and ``run_integration`` always executes the deployed version, so skipping this step means tests run stale code and real document events still fire the previous version. To roll back a bad deploy, use ``revert_integration_version`` wi...

NameTypeRequiredDescription
integration_idstringrequiredNo description.
affindamcp_get_data_source#Get one data source by ID — name, schema, and key/display properties.1 param

Get one data source by ID — name, schema, and key/display properties.

NameTypeRequiredDescription
data_source_idstringrequiredNo description.
affindamcp_get_document#Get one document by ID — state, workspace, document type, and basic metadata.1 param

Get one document by ID — state, workspace, document type, and basic metadata.

NameTypeRequiredDescription
document_idstringrequiredNo description.
affindamcp_get_document_extraction#Get the extracted data for one document — raw text plus all field values.1 param

Get the extracted data for one document — raw text plus all field values.

NameTypeRequiredDescription
document_idstringrequiredNo description.
affindamcp_get_document_type#Get one document type by ID — name, organization, and counts only.1 param

Get one document type by ID — name, organization, and counts only.

NameTypeRequiredDescription
document_type_idstringrequiredNo description.
affindamcp_get_document_type_details#Get a document type's full configuration — settings + counts.1 param

Get a document type's full configuration — settings + counts.

NameTypeRequiredDescription
document_type_idstringrequiredNo description.
affindamcp_get_field#Get one field by ID — full settings, formatter, and relationships.1 param

Get one field by ID — full settings, formatter, and relationships.

NameTypeRequiredDescription
field_idstringrequiredNo description.
affindamcp_get_field_group#Get one field group by ID — label, position, parent document type.1 param

Get one field group by ID — label, position, parent document type.

NameTypeRequiredDescription
field_group_idstringrequiredNo description.
affindamcp_get_integration#Get one integration by ID — full configuration, code, and connections.1 param

Get one integration by ID — full configuration, code, and connections.

NameTypeRequiredDescription
integration_idstringrequiredNo description.
affindamcp_get_integration_run#Get one integration run by ID — full, untruncated logs and output.1 param

Get one integration run by ID — full, untruncated logs and output.

NameTypeRequiredDescription
integration_run_idstringrequiredNo description.
affindamcp_get_usage#Get daily credits consumption for an organization over a date range.5 params

Get daily credits consumption for an organization over a date range.

NameTypeRequiredDescription
organization_idstringrequiredNo description.
document_type_idstringoptionalNo description.
end_datestringoptionalNo description.
start_datestringoptionalNo description.
workspace_idstringoptionalNo description.
affindamcp_get_validation_rule#Get one validation rule by ID — prompt, enabled, fields, missing-data option.1 param

Get one validation rule by ID — prompt, enabled, fields, missing-data option.

NameTypeRequiredDescription
validation_rule_idstringrequiredNo description.
affindamcp_get_workspace#Get one workspace by ID — name, organization, and document counts only.1 param

Get one workspace by ID — name, organization, and document counts only.

NameTypeRequiredDescription
workspace_idstringrequiredNo description.
affindamcp_get_workspace_details#Get a workspace's full configuration — settings + counts.1 param

Get a workspace's full configuration — settings + counts.

NameTypeRequiredDescription
workspace_idstringrequiredNo description.
affindamcp_list_data_source_values#List the rows (records) stored in a data source.2 params

List the rows (records) stored in a data source.

NameTypeRequiredDescription
data_source_idstringrequiredNo description.
limitintegeroptionalNo description.
affindamcp_list_data_sources#List data sources (lookup tables) defined on an organization.2 params

List data sources (lookup tables) defined on an organization.

NameTypeRequiredDescription
organization_idstringrequiredNo description.
limitintegeroptionalNo description.
affindamcp_list_document_splitters#List document splitters available to an organization.1 param

List document splitters available to an organization.

NameTypeRequiredDescription
organization_idstringrequiredNo description.
affindamcp_list_document_types#List document types in an organization.2 params

List document types in an organization.

NameTypeRequiredDescription
organization_idstringrequiredNo description.
limitintegeroptionalNo description.
affindamcp_list_documents#List documents in a workspace with their state and basic metadata.4 params

List documents in a workspace with their state and basic metadata.

NameTypeRequiredDescription
workspace_idstringrequiredNo description.
limitintegeroptionalNo description.
search_textstringoptionalNo description.
statestringoptionalNo description.
affindamcp_list_fields#List a document type's full field schema, grouped by field group.1 param

List a document type's full field schema, grouped by field group.

NameTypeRequiredDescription
document_type_idstringrequiredNo description.
affindamcp_list_integration_connections#List third-party service connections in an organization.1 param

List third-party service connections in an organization.

NameTypeRequiredDescription
organization_idstringrequiredNo description.
affindamcp_list_integration_runs#List recent runs for an integration, newest first.2 params

List recent runs for an integration, newest first.

NameTypeRequiredDescription
integration_idstringrequiredNo description.
limitintegeroptionalNo description.
affindamcp_list_integration_secrets#List the names of secrets configured for an integration.1 param

List the names of secrets configured for an integration.

NameTypeRequiredDescription
integration_idstringrequiredNo description.
affindamcp_list_integration_versions#List deployed-version snapshots for an integration, newest first.2 params

List deployed-version snapshots for an integration, newest first.

NameTypeRequiredDescription
integration_idstringrequiredNo description.
limitintegeroptionalNo description.
affindamcp_list_integrations#List integrations in an organization.4 params

List integrations in an organization.

NameTypeRequiredDescription
organization_idstringrequiredNo description.
enabledstringoptionalNo description.
limitintegeroptionalNo description.
workspace_idstringoptionalNo description.
affindamcp_list_matching_criteria#List matching criteria configured on a field.1 param

List matching criteria configured on a field.

NameTypeRequiredDescription
field_idstringrequiredNo description.
affindamcp_list_model_memory_documents#List the confirmed reference documents currently in a document type's model memory.2 params

List the confirmed reference documents currently in a document type's model memory.

NameTypeRequiredDescription
document_type_idstringrequiredNo description.
limitintegeroptionalNo description.
affindamcp_list_organizations#List organizations the current user belongs to.1 param

List organizations the current user belongs to.

NameTypeRequiredDescription
limitintegeroptionalNo description.
affindamcp_list_pipedream_apps#Search the catalogue of Pipedream apps available for new connections.1 param

Search the catalogue of Pipedream apps available for new connections.

NameTypeRequiredDescription
search_querystringoptionalNo description.
affindamcp_list_recent_field_annotations#Spot-check how one field is being extracted across recent documents.3 params

Spot-check how one field is being extracted across recent documents.

NameTypeRequiredDescription
field_idstringrequiredNo description.
filter_bystringoptionalNo description.
limitintegeroptionalNo description.
affindamcp_list_validation_rules#List validation rules attached to a document type.2 params

List validation rules attached to a document type.

NameTypeRequiredDescription
document_type_idstringrequiredNo description.
limitintegeroptionalNo description.
affindamcp_list_workspaces#List workspaces in an organization.2 params

List workspaces in an organization.

NameTypeRequiredDescription
organization_idstringrequiredNo description.
limitintegeroptionalNo description.
affindamcp_populate_document_type_fields#Auto-suggest fields for a document type by analysing sample documents.3 params

Auto-suggest fields for a document type by analysing sample documents.

NameTypeRequiredDescription
document_idsarrayrequiredNo description.
document_type_idstringrequiredNo description.
instructionsstringoptionalNo description.
affindamcp_reassign_document_type#Reassign documents to a different document type in the same workspace.3 params

Reassign documents to a different document type in the same workspace.

NameTypeRequiredDescription
document_idsarrayrequiredNo description.
document_type_idstringrequiredNo description.
reparsebooleanoptionalNo description.
affindamcp_reject_documents#Move documents to ``rejected`` state.1 param

Move documents to ``rejected`` state.

NameTypeRequiredDescription
document_idsarrayrequiredNo description.
affindamcp_remove_connection_from_integration#Detach a service connection from an integration.2 params

Detach a service connection from an integration.

NameTypeRequiredDescription
connection_idstringrequiredNo description.
integration_idstringrequiredNo description.
affindamcp_revert_integration_version#Roll an integration back to a previous version and redeploy it.2 params

Roll an integration back to a previous version and redeploy it.

NameTypeRequiredDescription
integration_idstringrequiredNo description.
version_idstringrequiredNo description.
affindamcp_run_integration#Execute an integration against one document as a test run.2 params

Execute an integration against one document as a test run.

NameTypeRequiredDescription
document_idstringrequiredNo description.
integration_idstringrequiredNo description.
affindamcp_set_integration_secret#Create or update a secret on an integration. The value is stored only as an environment variable on the Lambda function — never in the database.3 params

Create or update a secret on an integration. The value is stored only as an environment variable on the Lambda function — never in the database.

NameTypeRequiredDescription
integration_idstringrequiredNo description.
namestringrequiredNo description.
valuestringrequiredNo description.
affindamcp_test_connection#Verify a service connection's credentials are still valid.1 param

Verify a service connection's credentials are still valid.

NameTypeRequiredDescription
connection_idstringrequiredNo description.
affindamcp_update_data_source#Update top-level settings on a data source (name, key, display property).4 params

Update top-level settings on a data source (name, key, display property).

NameTypeRequiredDescription
data_source_idstringrequiredNo description.
display_propertystringoptionalNo description.
key_propertystringoptionalNo description.
namestringoptionalNo description.
affindamcp_update_data_source_value#Update one row in a data source by its key — partial merge.3 params

Update one row in a data source by its key — partial merge.

NameTypeRequiredDescription
data_source_idstringrequiredNo description.
keystringrequiredNo description.
valuestringrequiredNo description.
affindamcp_update_document_type#Update one or more settings on an existing document type.5 params

Update one or more settings on an existing document type.

NameTypeRequiredDescription
document_type_idstringrequiredNo description.
auto_refresh_validation_resultsstringoptionalNo description.
disable_confirmation_if_validation_rules_failstringoptionalNo description.
namestringoptionalNo description.
show_redact_buttonstringoptionalNo description.
affindamcp_update_field#Update one or more settings on an existing field.21 params

Update one or more settings on an existing field.

NameTypeRequiredDescription
field_idstringrequiredNo description.
auto_confirm_if_validation_rules_passstringoptionalNo description.
decimal_placesstringoptionalNo description.
descriptionstringoptionalNo description.
display_enum_valuestringoptionalNo description.
display_raw_textstringoptionalNo description.
drop_nullstringoptionalNo description.
enabledstringoptionalNo description.
field_group_idstringoptionalNo description.
field_typestringoptionalNo description.
hide_enum_detailstringoptionalNo description.
labelstringoptionalNo description.
manual_entrystringoptionalNo description.
mapping_data_source_idstringoptionalNo description.
multiplestringoptionalNo description.
no_rectstringoptionalNo description.
optionsstringoptionalNo description.
positionstringoptionalNo description.
return_first_instance_onlystringoptionalNo description.
slugstringoptionalNo description.
transformation_promptstringoptionalNo description.
affindamcp_update_integration#Update one or more settings — including code — on an integration.8 params

Update one or more settings — including code — on an integration.

NameTypeRequiredDescription
integration_idstringrequiredNo description.
descriptionstringoptionalNo description.
document_type_idstringoptionalNo description.
enabledstringoptionalNo description.
eventstringoptionalNo description.
namestringoptionalNo description.
python_codestringoptionalNo description.
workspace_idstringoptionalNo description.
affindamcp_update_matching_criterion#Update settings on an existing matching criterion.7 params

Update settings on an existing matching criterion.

NameTypeRequiredDescription
matching_criterion_idstringrequiredNo description.
data_source_propertystringoptionalNo description.
field_attributestringoptionalNo description.
match_typestringoptionalNo description.
requiredstringoptionalNo description.
required_strictstringoptionalNo description.
source_field_idstringoptionalNo description.
affindamcp_update_organization#Rename an organization.2 params

Rename an organization.

NameTypeRequiredDescription
namestringrequiredNo description.
organization_idstringrequiredNo description.
affindamcp_update_validation_rule#Update one or more settings on an existing validation rule.6 params

Update one or more settings on an existing validation rule.

NameTypeRequiredDescription
validation_rule_idstringrequiredNo description.
enabledstringoptionalNo description.
field_idsstringoptionalNo description.
generate_codebooleanoptionalNo description.
missing_data_optionstringoptionalNo description.
promptstringoptionalNo description.
affindamcp_update_workspace#Update one or more settings on an existing workspace.11 params

Update one or more settings on an existing workspace.

NameTypeRequiredDescription
workspace_idstringrequiredNo description.
auto_validationstringoptionalNo description.
document_splitter_idstringoptionalNo description.
enable_document_classificationstringoptionalNo description.
enable_document_splittingstringoptionalNo description.
enable_validationstringoptionalNo description.
model_memory_strategystringoptionalNo description.
namestringoptionalNo description.
ocr_modestringoptionalNo description.
reject_duplicatesstringoptionalNo description.
visibilitystringoptionalNo description.
affindamcp_wait_for_document_processing#Block until every document in a workspace has finished processing.2 params

Block until every document in a workspace has finished processing.

NameTypeRequiredDescription
workspace_idstringrequiredNo description.
timeout_secondsintegeroptionalNo description.