Enboarder MCP by usefulapi
Read workflows, forms and brands; launch, update and cancel workflows in Enboarder.
Sollte ich dies verwenden
Qualität und Sicherheit
Befunde (2)
- LOWTool 'enboarder_get_workflow_properties' name length outside 3-30 rangein enboarder_get_workflow_properties
- LOWTool 'enboarder_get_workflow_data_by_id' name length outside 3-30 rangein enboarder_get_workflow_data_by_id
Basierend auf einer automatisierten Analyse der Tool-Definitionen und der Einhaltung des Protokolls.
Kontextkosten
Dies ist die ungefähre Anzahl der Tokens, die jedes Mal verbraucht werden, wenn die Tools des Servers in den Kontext eines Modells geladen werden. Höhere Werte verringern die Aufmerksamkeit, die für andere Aufgaben verfügbar ist.
Installieren
Installation mit einem Klick
Fügen Sie dies Ihrer Datei `claude_desktop_config.json` hinzu:
{
"mcpServers": {
"enboarder": {
"url": "https://enboarder.usefulapi.io/mcp"
}
}
}Remote-Endpunkte
https://enboarder.usefulapi.io/mcpstreamable-httpWas es kann
Tool-Inventar
Tools (15)
🟢enboarder_list_workflows
List workflow definitions (id, name, isActive). Start here to find workflow ids. GET /reports/workflows.
Eingabe-Schema
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢enboarder_get_workflow_properties(workflow_id)
List the categories, custom fields and stakeholders (managers) configured for one workflow. GET /reports/workflows/{id}/properties.
Eingabe-Schema
{
"type": "object",
"properties": {
"workflow_id": {
"type": "string",
"minLength": 1
}
},
"required": [
"workflow_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢enboarder_get_workflow_data(next_key)
List launched workflow instances (employee, status, start date, custom fields, managers) across all workflows. By default the last year. Returns up to one page; pass next_key for more. GET /reports/workflows/data.
Eingabe-Schema
{
"type": "object",
"properties": {
"next_key": {
"description": "nextKey from the previous response, to get the next page.",
"type": "string"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢enboarder_get_workflow_data_by_id(workflow_id, next_key)
List launched instances of ONE workflow (employee, status, start date, custom fields, managers). By default the last year. GET /reports/workflows/{id}/data.
Eingabe-Schema
{
"type": "object",
"properties": {
"workflow_id": {
"type": "string",
"minLength": 1
},
"next_key": {
"description": "nextKey from the previous response, to get the next page.",
"type": "string"
}
},
"required": [
"workflow_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢enboarder_list_forms
List forms (id, name). GET /reports/forms.
Eingabe-Schema
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢enboarder_get_form_properties(form_id)
List the questions (field names, types, options) of one form. GET /reports/forms/{id}/properties.
Eingabe-Schema
{
"type": "object",
"properties": {
"form_id": {
"type": "string",
"minLength": 1
}
},
"required": [
"form_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢enboarder_get_form_data(form_id, submit_start_date, submit_end_date, select, next_key)
Get form submissions with questions, answers and the workflow custom fields. 500 records per page; pass next_key for more. GET /reports/forms/{id}/data.
Eingabe-Schema
{
"type": "object",
"properties": {
"form_id": {
"type": "string",
"minLength": 1
},
"submit_start_date": {
"description": "Start of the submit date range, yyyy-mm-dd.",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"submit_end_date": {
"description": "End of the submit date range, yyyy-mm-dd.",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"select": {
"description": "Comma separated field names to return (default: all).",
"type": "string"
},
"next_key": {
"description": "nextKey from the previous response, to get the next page.",
"type": "string"
}
},
"required": [
"form_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢enboarder_get_profile(profile_id, include_active_workflows)
Get one employee profile by its external id (contact details, profile fields, optionally active workflows). GET /restapi/v1/profile/{id}.
Eingabe-Schema
{
"type": "object",
"properties": {
"profile_id": {
"type": "string",
"minLength": 1,
"description": "The externalid of the profile."
},
"include_active_workflows": {
"description": "Also return up to 10 active workflows.",
"type": "boolean"
}
},
"required": [
"profile_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢enboarder_list_brands
List brands of the account. GET /restapi/v1/settings/brand/all.
Eingabe-Schema
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢enboarder_list_locations
List locations of the account. GET /restapi/v1/settings/location/all.
Eingabe-Schema
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢enboarder_list_categories
List categories of the account. GET /restapi/v1/settings/category/all.
Eingabe-Schema
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢enboarder_list_custom_fields
List custom fields of the account. GET /restapi/v1/settings/customfield/all.
Eingabe-Schema
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴enboarder_launch_workflow(employee_name, employee_email, employee_mobile, employee_channel, manager_name, ...)
WRITE: start an onboarding workflow for one employee with one manager (this can send messages to the employee and manager). Needs the employee full name, one contact (email or mobile), the manager full name and contact, and the start date. mode 0 (default) does not launch if the external id already exists. POST /restapi/v1/startwf/basic.
Eingabe-Schema
{
"type": "object",
"properties": {
"employee_name": {
"type": "string",
"minLength": 1,
"description": "Full name of the employee."
},
"employee_email": {
"type": "string"
},
"employee_mobile": {
"description": "International format, for example +61415000000.",
"type": "string"
},
"employee_channel": {
"description": "Preferred channel (default mob).",
"type": "string",
"enum": [
"mob",
"eml"
]
},
"manager_name": {
"type": "string",
"minLength": 1
},
"manager_email": {
"type": "string"
},
"manager_mobile": {
"type": "string"
},
"manager_channel": {
"type": "string",
"enum": [
"mob",
"eml"
]
},
"start_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"custom_fields": {
"description": "Custom fields as name/value pairs. Names must match the labels in Enboarder.",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Label of the custom field, or 'brand', 'location', or a category name."
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
]
}
},
"external_id": {
"description": "Unique id from your system. Enboarder makes one if omitted.",
"type": "string"
},
"mode": {
"description": "0 = skip if external id exists (default); 1 = cancel the existing one and relaunch; 2 = allow several with different criteria.",
"anyOf": [
{
"type": "number",
"const": 0
},
{
"type": "number",
"const": 1
},
{
"type": "number",
"const": 2
}
]
}
},
"required": [
"employee_name",
"manager_name",
"start_date"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟡enboarder_update_workflow(external_id, start_date, custom_fields)
WRITE: change a running workflow found by its external id (partial update: send only what changes, for example start_date or custom fields). Fails if the workflow is complete or cancelled. PUT /restapi/v1/updatewf.
Eingabe-Schema
{
"type": "object",
"properties": {
"external_id": {
"type": "string",
"minLength": 1,
"description": "External id of the workflow instance."
},
"start_date": {
"description": "New start date.",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"custom_fields": {
"description": "Custom fields as name/value pairs. Names must match the labels in Enboarder.",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Label of the custom field, or 'brand', 'location', or a category name."
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
]
}
}
},
"required": [
"external_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴enboarder_cancel_workflow(external_id, comments, mode)
WRITE (cannot be undone): cancel a running workflow found by its external id. mode ALL (default) cancels every workflow with that external id. POST /restapi/v1/cancelwf.
Eingabe-Schema
{
"type": "object",
"properties": {
"external_id": {
"type": "string",
"minLength": 1,
"description": "External id of the workflow instance."
},
"comments": {
"description": "Reason for the cancellation.",
"type": "string"
},
"mode": {
"description": "ALL (default) or SELECTED.",
"type": "string",
"enum": [
"ALL",
"SELECTED"
]
}
},
"required": [
"external_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Community
Nachweis