Skip to main content

Model Context Protocol (MCP) API

You can connect to the Simplicate MCP API to enable easier interaction between AI and Simplicate.

For information about getting access, please refer to Zet AI in via de Simplicate MCP

Setup​

Start by creating an API token in Simplicate that allows use by Simplicate AI-tooling. Go to settings → API → Add. mcp_api_token_creation.png

The token consists of an API-key and API-secret. Combine them with a : between to get your API token: {API-key}:{API-secret}. For example: 1234567890:0987654321. Use this token as an Authentication Bearer token when connecting to the MCP API.

The MCP API is available at https://<your-simplicate-domain>.simplicate.app/mcp. Replace <your-simplicate-domain> with your Simplicate environment.

Supported tools​

When connected to the Simplicate MCP API you can view and use all available tools it provides. Below is a non-exhaustive list of tools provided to give an indication of its capabilities.

search-entity-information​

Search for an entity in Simplicate and return its details.

Parameters:

  • search_term: Search term to search for, each entity determines which fields are searched.
  • entity_type: Type of the entity to search information for. Possible values:project, sales, organization, person, employee, invoice.

register-hour-time-aware​

Register hours in Simplicate by defining a registration date, a start time and duration in minutes or end time. The registration is registered with a specific start- and end time.

Parameters:

  • employee_id: Employee Id of the employee to register the hours for.
  • project_id: Project Id of the project to register the hours for.
  • project_service_id: Project service ID of the project service to register the hours for.
  • type_id: Hour type Id of the hour type to register the hours for.
  • registrationDate: The date (YYYY-MM-DD) to register the hour for, defaults to today if not set.
  • note: Optional note that can be added to the hour registration, supports max 1000 characters.
  • start_time: Start time of the hour registration in HH:mm format.
  • end_time: End time of the hour registration in HH:mm format.

register-hour-time-unaware​

Register hours in Simplicate by defining a registration date and a duration in minutes. The hour is registered as a block of time without a specific start- and end time.

Parameters:

  • employee_id: Employee Id of the employee to register the hours for.
  • project_id: Project Id of the project to register the hours for.
  • project_service_id: Project service ID of the project service to register the hours for.
  • type_id: Hour type Id of the hour type to register the hours for.
  • registrationDate: The date (YYYY-MM-DD) to register the hour for, defaults to today if not set.
  • note: Optional note that can be added to the hour registration, supports max 1000 characters.
  • duration_in_minutes: Duration of the hour registration in minutes, defaults to 30 minutes if not set.

create-timeline-note​

Create a note in the timeline of an entity.

Parameters:

  • employee_id: Employee Id of the employee that is the creator of the note.
  • note: Note to create in the timeline.
  • entity_id: Id of the entity to create the note for.
  • entity_type: Type of the entity to create the note for. Possible values: project, sales, organization, person, invoice.