MCP serverAvailable tools
Read employees
Search or retrieve payroll employee records.
MCP tool
get_employeesPurpose
- Use when
- You need an employee identifier or payroll profile.
- Do not use when
- You need to create or update an employee.
- Required permissions
- Side effects
- None
- Idempotency
- Idempotent
Input schema
JSON Schema{ "type": "object", "properties": { "input": { "oneOf": [ { "type": "object", "properties": { "operation": { "const": "search" }, "query": { "type": "string", "minLength": 1 }, "cursor": { "type": "string" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "operation" ], "additionalProperties": false }, { "type": "object", "properties": { "operation": { "const": "get" }, "employeeId": { "type": "string" } }, "required": [ "operation", "employeeId" ], "additionalProperties": false } ] } }, "required": [ "input" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false}Output schema
JSON Schema{ "type": "object", "properties": { "data": { "anyOf": [ { "type": "object", "properties": { "employees": { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "hasMore": { "type": "boolean" } }, "required": [ "employees", "nextCursor", "hasMore" ], "additionalProperties": false }, { "$ref": "#/definitions/__schema0" } ] }, "error": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "code": { "enum": [ "validation_error", "unauthenticated", "forbidden", "payment_required", "not_found", "method_not_allowed", "conflict", "idempotency_conflict", "operation_in_progress", "recovery_required", "migration_required", "rate_limited", "provider_unavailable", "internal" ] }, "message": { "type": "string" }, "details": { "type": "object", "properties": { "document": { "type": "object", "properties": { "documentRef": { "type": "string", "pattern": "^(invoice|withholding|sales_receipt|declaration|tax_compliance_opinion|sales_receipt_refund):.+$" }, "editable": { "type": "boolean" } }, "required": [ "documentRef", "editable" ], "additionalProperties": false }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "retryable": { "type": "boolean" }, "retryAfterSeconds": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "reason": { "type": "string" }, "balanceMinor": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "topUpUrl": { "type": "string" } }, "additionalProperties": false } }, "required": [ "code", "message" ], "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "type": "object", "properties": { "employeeId": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "postalCode": { "type": "string" }, "taxSystem": { "type": "string" }, "employeeNumber": { "type": "string" }, "curp": { "type": "string" }, "socialSecurityNumber": { "type": "string" }, "jobTitle": { "type": "string" }, "department": { "type": "string" }, "paymentFrequency": { "type": "string" }, "employmentStartDate": { "type": "string" }, "contractType": { "type": "string" }, "workScheduleType": { "type": "string" }, "regimeType": { "type": "string" }, "positionRisk": { "type": "string" }, "federalEntityCode": { "type": "string" }, "unionMember": { "type": "string" }, "bankCode": { "type": "string" }, "bankAccount": { "type": "string" }, "contactEmail": { "type": "string" }, "payrollStatus": { "allOf": [ { "enum": [ "active", "inactive" ] } ] }, "employmentEndedOn": { "type": "string" }, "payroll": { "type": "object", "properties": { "salary": { "type": "object", "properties": { "amount": { "type": "number" }, "unit": { "enum": [ "day", "week", "decena", "catorcena", "quincena", "month" ] } }, "required": [ "amount", "unit" ], "additionalProperties": false }, "sdiOverride": { "type": "number" }, "subsidyAppliedElsewhere": { "type": "boolean" }, "minimumWageZone": { "enum": [ "general", "northBorder" ] }, "fixedDeductions": { "type": "array", "items": { "$ref": "#/definitions/__schema2" } }, "lastReceiptDeductionsDismissed": { "type": "boolean" } }, "additionalProperties": false }, "payrollReadiness": { "type": "object", "properties": { "ready": { "type": "boolean" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "enum": [ "rfc_invalid", "tax_system_invalid", "postal_code_invalid", "curp_invalid", "employee_number_invalid", "contract_type_invalid", "regime_type_invalid", "payment_frequency_invalid", "unsupported_regime", "unsupported_contract", "unsupported_frequency", "state_code_missing", "social_security_number_missing", "employment_start_missing", "position_risk_missing", "integrated_daily_salary_missing", "bank_account_invalid", "job_title_invalid", "department_invalid", "work_schedule_type_invalid", "contribution_base_salary_invalid", "salary_missing", "salary_below_minimum_wage", "minimum_wage_zone_missing", "last_receipt_deductions_missing", "employer_rfc_missing", "employer_registration_missing", "employer_curp_missing" ] }, "field": { "type": "string" } }, "required": [ "code", "field" ], "additionalProperties": false } } }, "required": [ "ready", "issues" ], "additionalProperties": false }, "lastReceiptDeductions": { "allOf": [ { "type": "array", "items": { "$ref": "#/definitions/__schema2" } } ] }, "rfc": { "type": "string" }, "lastPayrollDate": { "type": "string", "format": "date-time" } }, "required": [ "employeeId", "name", "payrollReadiness", "rfc" ], "additionalProperties": false }, "__schema2": { "type": "object", "properties": { "type": { "type": "string" }, "amount": { "type": "number" }, "description": { "type": "string" } }, "required": [ "type", "amount" ], "additionalProperties": false } }, "oneOf": [ { "required": [ "data" ] }, { "required": [ "error" ] } ]}