Microkeeper MCP by usefulapi

Read staff profiles. Give changed_since (yyyy-mm-dd, up to a year back) for everyone changed since then, or ids with id_type for specific staff. With neither, returns all active staff. Action get_employees (HR/Staff, Read Only).

{
  "type": "object",
  "properties": {
    "changed_since": {
      "description": "Staff changed on or after this date.",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    },
    "id_type": {
      "description": "The kind of ID in ids.",
      "type": "string",
      "enum": [
        "EmployeeID",
        "EID",
        "eusername"
      ]
    },
    "ids": {
      "description": "Staff IDs of the kind in id_type.",
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Read the account's Groups (teams and sites that staff belong to). Action get_group_config (HR/Staff, Read Only).

{
  "type": "object",
  "properties": {
    "active_status": {
      "description": "Default \"active\".",
      "type": "string",
      "enum": [
        "active",
        "hidden",
        "all"
      ]
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Read every Location (site) with its LID, third_ID, address, active flag and managers. Action get_locations (Account, Read Only).

{
  "type": "object",
  "properties": {},
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Read every Role (active and inactive) with its ROID and required skills. Action get_roles (Account, Read Only).

{
  "type": "object",
  "properties": {},
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Read Jobs (projects, sites or functions staff clock to). Give JID or JobID lists for specific Jobs; otherwise status all or finished. Action get_jobs (Account, Read Only).

{
  "type": "object",
  "properties": {
    "status": {
      "description": "Default \"all\" (every Job that is not finished).",
      "type": "string",
      "enum": [
        "all",
        "finished"
      ]
    },
    "JID": {
      "description": "Microkeeper Job IDs.",
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "JobID": {
      "description": "Your software's Job IDs.",
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Read rostered shifts for every employee at active Locations, for up to 31 days (inclusive). Action get_roster (Roster, Read Only).

{
  "type": "object",
  "properties": {
    "start_date": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "First day, yyyy-mm-dd."
    },
    "end_date": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "Last day, yyyy-mm-dd."
    }
  },
  "required": [
    "start_date",
    "end_date"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Read worked shifts for up to 31 days (inclusive), for all staff or the usernames given. Action get_timesheet (Roster, Read Only).

{
  "type": "object",
  "properties": {
    "start_date": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    },
    "end_date": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    },
    "eusernames": {
      "description": "Microkeeper usernames. Leave out for all staff.",
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "start_date",
    "end_date"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Read leave requests that start, end or run through a date range: type, dates and status. Action get_leave (Payroll, Read Only).

{
  "type": "object",
  "properties": {
    "start_date": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    },
    "end_date": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    }
  },
  "required": [
    "start_date",
    "end_date"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Add new staff or update existing ones (matched by EmployeeID, then eusername, then EID). Only the fields you send change. A new employee gets a login email only if you set welcome. Action upsert_employees (HR/Staff, Read/Write).

{
  "type": "object",
  "properties": {
    "employees": {
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "EmployeeID": {
            "description": "Your software's ID for the person. A known ID updates; a new ID adds.",
            "type": "string"
          },
          "EID": {
            "description": "Microkeeper's employee ID. Updates only.",
            "type": "string"
          },
          "eusername": {
            "description": "Microkeeper username. Updates only.",
            "type": "string"
          },
          "firstname": {
            "type": "string",
            "minLength": 1,
            "description": "Required on every employee, updates included."
          },
          "lastname": {
            "type": "string",
            "minLength": 1,
            "description": "Required on every employee, updates included."
          },
          "email": {
            "description": "Changing it asks the employee to verify the new address.",
            "type": "string"
          },
          "phoneno": {
            "description": "Changing it asks the employee to verify the new number.",
            "type": "string"
          },
          "address": {
            "type": "string"
          },
          "city": {
            "type": "string"
          },
          "state": {
            "type": "string"
          },
          "postcode": {
            "type": "string"
          }
        },
        "required": [
          "firstname",
          "lastname"
        ],
        "additionalProperties": {}
      },
      "description": "Staff to add or update."
    }
  },
  "required": [
    "employees"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Add Locations or update them (matched by LID, or by third_ID). Locations you do not send stay as they are. Action upsert_locations (Account, Read/Write).

{
  "type": "object",
  "properties": {
    "locations": {
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "LID": {
            "description": "Microkeeper's Location ID. A known LID updates; 0 with a new third_ID adds.",
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          },
          "third_ID": {
            "description": "Your software's ID for the Location.",
            "type": "string"
          },
          "title": {
            "type": "string",
            "minLength": 1
          },
          "active": {
            "type": "string",
            "enum": [
              "0",
              "1"
            ],
            "description": "\"1\" active, \"0\" inactive."
          },
          "manager_eusername": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "title",
          "active"
        ],
        "additionalProperties": {}
      },
      "description": "Locations to add or update."
    }
  },
  "required": [
    "locations"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Add Jobs or update them (matched by JobID, or by JID; JID 0 adds). Jobs you do not send are not changed. Action update_jobs (Account, Read/Write).

{
  "type": "object",
  "properties": {
    "jobs": {
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "JobID": {
            "description": "Your software's ID for the Job.",
            "type": "string"
          },
          "JID": {
            "description": "Microkeeper's Job ID. 0 adds a Job.",
            "type": [
              "string",
              "number"
            ]
          },
          "title": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "enum": [
              "Active",
              "Finished"
            ]
          },
          "startdate": {
            "type": "string",
            "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
          },
          "enddate": {
            "type": "string",
            "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
          }
        },
        "required": [
          "title"
        ],
        "additionalProperties": {}
      },
      "description": "Jobs to add or update."
    }
  },
  "required": [
    "jobs"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}