SF-MCP

Retrieve OData entity metadata/configuration from a SuccessFactors instance.

This tool fetches the $metadata document for a specific entity, showing all available fields, their types, and constraints.

Args: instance: The SuccessFactors instance/company ID entity: OData entity to inspect (e.g., "User", "EmpEmployment", "Position") data_center: SAP data center code (e.g., 'DC55', 'DC10', 'DC4') environment: Environment type ('preview', 'production', 'sales_demo') auth_user_id: SuccessFactors user ID for authentication (required) auth_password: SuccessFactors password for authentication (required)

Returns: dict containing entity metadata with field definitions

Compare entity configuration/metadata between two SuccessFactors instances.

This is useful for verifying that dev/test/production environments are aligned before deployments, or for auditing configuration drift.

Args: instance1: First SF instance/company ID (e.g., dev instance) instance2: Second SF instance/company ID (e.g., prod instance) entity: OData entity to compare (e.g., "User", "EmpEmployment", "Position") data_center1: SAP data center for instance1 (e.g., 'DC55') environment1: Environment for instance1 ('preview', 'production') data_center2: SAP data center for instance2 (e.g., 'DC55') environment2: Environment for instance2 ('preview', 'production') auth_user_id: SuccessFactors user ID for authentication (required, used for both instances) auth_password: SuccessFactors password for authentication (required, used for both instances)

Returns: dict containing comparison results with match percentage and field differences

List all available OData entities in the SuccessFactors instance.

This discovery tool helps users understand what data is available to query. It fetches the service document which lists all entity sets.

Args: instance: The SuccessFactors instance/company ID data_center: SAP data center code (e.g., 'DC55', 'DC10', 'DC4') environment: Environment type ('preview', 'production', 'sales_demo') auth_user_id: SuccessFactors user ID for authentication (required) auth_password: SuccessFactors password for authentication (required) category: Optional filter - 'foundation', 'employee', 'talent', 'platform', 'all' (default: all)

Returns: dict containing entity list, count, and optional category breakdown

Get all Role-Based Permission (RBP) roles in the instance.

Lists all security roles configured in the system, including admin roles, HR roles, manager roles, and employee self-service roles.

Args: instance: The SuccessFactors instance/company ID data_center: SAP data center code (e.g., 'DC55', 'DC10', 'DC4') environment: Environment type ('preview', 'production', 'sales_demo') auth_user_id: SuccessFactors user ID for authentication (required) auth_password: SuccessFactors password for authentication (required) include_description: If True, includes detailed role descriptions

Get detailed permissions for a specific RBP role.

Shows what each role can access and do - essential for security audits.

Args: instance: The SuccessFactors instance/company ID role_id: The role ID to get permissions for (e.g., "10") data_center: SAP data center code (e.g., 'DC55', 'DC10', 'DC4') environment: Environment type ('preview', 'production', 'sales_demo') auth_user_id: SuccessFactors user ID for authentication (required) auth_password: SuccessFactors password for authentication (required) locale: Locale for labels (default: en-US)

Get all permissions for a specific user across all their assigned roles.

Useful for answering 'What can this user do?' by showing their complete permission set.

Args: instance: The SuccessFactors instance/company ID user_id: The user ID to look up permissions for data_center: SAP data center code (e.g., 'DC55', 'DC10', 'DC4') environment: Environment type ('preview', 'production', 'sales_demo') auth_user_id: SuccessFactors user ID for authentication (required) auth_password: SuccessFactors password for authentication (required) locale: Locale for labels (default: en-US)

Get all RBP roles assigned to a specific user.

This tool complements get_user_permissions by showing which roles are assigned to a user, not just the resulting permissions.

Args: instance: The SuccessFactors instance/company ID user_id: The user ID to look up roles for data_center: SAP data center code (e.g., 'DC55', 'DC10', 'DC4') environment: Environment type ('preview', 'production', 'sales_demo') auth_user_id: SuccessFactors user ID for authentication (required) auth_password: SuccessFactors password for authentication (required) include_permissions: If True, also fetches permissions for each role

Get the mapping of permission type labels for RBP security analysis.

This metadata helps understand what permission categories exist in the system, mapping technical IDs to human-readable labels.

Args: instance: The SuccessFactors instance/company ID data_center: SAP data center code (e.g., 'DC55', 'DC10', 'DC4') environment: Environment type ('preview', 'production', 'sales_demo') auth_user_id: SuccessFactors user ID for authentication (required) auth_password: SuccessFactors password for authentication (required) locale: Locale for labels (default: en-US)

Check if a specific user has a particular permission.

Quickly verify whether a user has access to a specific feature or data.

Args: instance: The SuccessFactors instance/company ID user_id: The user ID to check permission_type: Permission type to check (e.g., "Employee Central Effective Dated Entities") data_center: SAP data center code (e.g., 'DC55', 'DC10', 'DC4') environment: Environment type ('preview', 'production', 'sales_demo') auth_user_id: SuccessFactors user ID for authentication (required) auth_password: SuccessFactors password for authentication (required) locale: Locale for labels (default: en-US)

List all dynamic permission groups in the instance.

Dynamic groups are used in RBP to define target populations.

Args: instance: The SuccessFactors instance/company ID data_center: SAP data center code (e.g., 'DC55', 'DC10', 'DC4') environment: Environment type ('preview', 'production', 'sales_demo') auth_user_id: SuccessFactors user ID for authentication (required) auth_password: SuccessFactors password for authentication (required) top: Maximum results (default: 100, max: 500)

Get modification history for RBP roles.

Returns who modified the role, when, and what changes were made. This helps audit role configuration changes over time.

Args: instance: The SuccessFactors instance/company ID data_center: SAP data center code (e.g., 'DC55', 'DC10', 'DC4') environment: Environment type ('preview', 'production', 'sales_demo') auth_user_id: SuccessFactors user ID for authentication (required) auth_password: SuccessFactors password for authentication (required) role_id: Optional role ID to filter (e.g., "10") role_name: Optional role name to filter (alternative to role_id) from_date: Optional start date filter (ISO format: YYYY-MM-DD) to_date: Optional end date filter (ISO format: YYYY-MM-DD) top: Maximum records to return (default 100, max 500)

Get history of role assignments - who was granted roles and when.

This tool shows the assignment history of RBP roles to users, helping audit who has been given access and by whom.

Args: instance: The SuccessFactors instance/company ID data_center: SAP data center code (e.g., 'DC55', 'DC10', 'DC4') environment: Environment type ('preview', 'production', 'sales_demo') auth_user_id: SuccessFactors user ID for authentication (required) auth_password: SuccessFactors password for authentication (required) role_id: Optional role ID to filter assignments for a specific role user_id: Optional user ID to filter assignments for a specific user from_date: Optional start date filter (ISO format: YYYY-MM-DD) to_date: Optional end date filter (ISO format: YYYY-MM-DD) top: Maximum records to return (default 100, max 500)

Query any OData entity with flexible filtering, sorting, and field selection.

This is the most flexible tool - it can query any entity in the system. Use other specialized tools for common queries (employee profiles, etc.).

Args: instance: The SuccessFactors instance/company ID entity: OData entity to query (e.g., "User", "EmpJob", "Position") data_center: SAP data center code (e.g., 'DC55', 'DC10', 'DC4') environment: Environment type ('preview', 'production', 'sales_demo') auth_user_id: SuccessFactors user ID for authentication (required) auth_password: SuccessFactors password for authentication (required) select: Comma-separated fields to return (e.g., "userId,firstName,lastName") filter: OData filter expression (e.g., "department eq 'Engineering'") orderby: Sort order (e.g., "hireDate desc") expand: Navigation properties to expand (e.g., "manager,hr") top: Maximum records (default 100, max 1000) skip: Records to skip for pagination (default 0)

Get all values for a specific picklist.

Picklists are used throughout SuccessFactors for dropdown fields. This tool retrieves all options for a given picklist, which is essential for data validation and understanding available field values.

Args: instance: The SuccessFactors instance/company ID picklist_id: The picklist identifier (e.g., "ecJobFunction", "nationality") data_center: SAP data center code (e.g., 'DC55', 'DC10', 'DC4') environment: Environment type ('preview', 'production', 'sales_demo') auth_user_id: SuccessFactors user ID for authentication (required) auth_password: SuccessFactors password for authentication (required) locale: Locale for labels (default: en-US) include_inactive: If True, includes inactive/expired values (default: False)

Common picklists: - ecJobFunction: Job functions - ecJobCode: Job codes - ecPayGrade: Pay grades - ecDepartment: Departments - nationality: Countries/nationalities - maritalStatus: Marital status options

Get a complete employee profile including job info, contact details, and manager.

Returns the employee's current job title, department, location, manager, email, phone, and hire date in a single call. Optionally includes compensation.

Args: instance: The SuccessFactors instance/company ID user_id: The employee's user ID (e.g., 'jsmith') data_center: SAP data center code (e.g., 'DC55', 'DC10', 'DC4') environment: Environment type ('preview', 'production', 'sales_demo') auth_user_id: SuccessFactors user ID for authentication (required) auth_password: SuccessFactors password for authentication (required) include_compensation: If True, also fetches current compensation details

Search for employees by name, department, location, or manager.

Find employees without knowing their exact user IDs. Supports partial name matching and filtering by department, location, or manager.

Args: instance: The SuccessFactors instance/company ID data_center: SAP data center code (e.g., 'DC55', 'DC10', 'DC4') environment: Environment type ('preview', 'production', 'sales_demo') auth_user_id: SuccessFactors user ID for authentication (required) auth_password: SuccessFactors password for authentication (required) search_text: Partial name to search (searches first name and last name) department: Filter by department name or code location: Filter by work location manager_id: Filter to show only this manager's direct reports status: Employee status filter: 'active', 'inactive', or 'all' (default: 'active') top: Maximum number of results to return (default: 50, max: 200)

View an employee's job history including promotions, transfers, and title changes.

Shows chronological job records with title, department, location, and manager for each period. Useful for reviewing career progression.

Args: instance: The SuccessFactors instance/company ID user_id: The employee's user ID data_center: SAP data center code (e.g., 'DC55', 'DC10', 'DC4') environment: Environment type ('preview', 'production', 'sales_demo') auth_user_id: SuccessFactors user ID for authentication (required) auth_password: SuccessFactors password for authentication (required) include_compensation_changes: If True, also fetches salary history

Get a manager's team roster with direct (and optionally indirect) reports.

Shows all active team members with their job title, department, location, and hire date. Useful for org chart views, team planning, and 1-on-1 prep.

Args: instance: The SuccessFactors instance/company ID manager_id: The manager's user ID data_center: SAP data center code (e.g., 'DC55', 'DC10', 'DC4') environment: Environment type ('preview', 'production', 'sales_demo') auth_user_id: SuccessFactors user ID for authentication (required) auth_password: SuccessFactors password for authentication (required) include_indirect_reports: If True, also fetches reports-of-reports (1 level deep) top: Maximum direct reports to return (default: 100, max: 200)

Check vacation, PTO, and sick leave balances for one or more employees.

Quickly answer 'How much PTO do I have?' for any employee. Supports checking multiple employees at once.

Args: instance: The SuccessFactors instance/company ID user_ids: Employee user ID(s) - single ID or comma-separated (max 50) data_center: SAP data center code (e.g., 'DC55', 'DC10', 'DC4') environment: Environment type ('preview', 'production', 'sales_demo') auth_user_id: SuccessFactors user ID for authentication (required) auth_password: SuccessFactors password for authentication (required) as_of_date: Check balance as of this date (YYYY-MM-DD). Defaults to today.

See who is out or taking time off in a date range (team absence calendar).

Shows all approved (or pending) absences for a period. Filter by department or manager to see just your team.

Args: instance: The SuccessFactors instance/company ID start_date: Start of date range (YYYY-MM-DD) end_date: End of date range (YYYY-MM-DD) data_center: SAP data center code (e.g., 'DC55', 'DC10', 'DC4') environment: Environment type ('preview', 'production', 'sales_demo') auth_user_id: SuccessFactors user ID for authentication (required) auth_password: SuccessFactors password for authentication (required) department: Filter by department name or code manager_id: Filter to a specific manager's team status: Filter by approval status: 'approved', 'pending', or 'all' (default: 'approved') top: Maximum results (default: 200, max: 500)

View time-off requests for approval tracking.

Shows pending, approved, or rejected time-off requests. Filter by employee or view all requests visible to you.

Args: instance: The SuccessFactors instance/company ID data_center: SAP data center code (e.g., 'DC55', 'DC10', 'DC4') environment: Environment type ('preview', 'production', 'sales_demo') auth_user_id: SuccessFactors user ID for authentication (required) auth_password: SuccessFactors password for authentication (required) user_id: Filter to a specific employee's requests (optional) status: Filter by status: 'pending', 'approved', 'rejected', 'cancelled', or 'all' (default: 'pending') from_date: Only show requests created on or after this date (YYYY-MM-DD) top: Maximum results (default: 50, max: 200)

List job requisitions with status and hiring manager.

Shows open (or all) job requisitions for tracking the hiring pipeline.

Args: instance: The SuccessFactors instance/company ID data_center: SAP data center code (e.g., 'DC55', 'DC10', 'DC4') environment: Environment type ('preview', 'production', 'sales_demo') auth_user_id: SuccessFactors user ID for authentication (required) auth_password: SuccessFactors password for authentication (required) department: Filter by department hiring_manager_id: Filter by hiring manager's user ID location: Filter by work location status: Requisition status: 'open', 'filled', 'closed', or 'all' (default: 'open') top: Maximum results (default: 100, max: 500)

Track candidates for a job requisition through hiring stages.

Shows all applicants for a specific job requisition with their current stage, application date, and status.

Args: instance: The SuccessFactors instance/company ID requisition_id: The job requisition ID data_center: SAP data center code (e.g., 'DC55', 'DC10', 'DC4') environment: Environment type ('preview', 'production', 'sales_demo') auth_user_id: SuccessFactors user ID for authentication (required) auth_password: SuccessFactors password for authentication (required) include_rejected: If True, include rejected candidates (default: False) top: Maximum results (default: 100, max: 500)

List recent and upcoming new hires for onboarding planning.

Shows employees hired within a date range with their job details.

Args: instance: The SuccessFactors instance/company ID start_date_from: Show hires starting on or after this date (YYYY-MM-DD) start_date_to: Show hires starting on or before this date (YYYY-MM-DD) data_center: SAP data center code (e.g., 'DC55', 'DC10', 'DC4') environment: Environment type ('preview', 'production', 'sales_demo') auth_user_id: SuccessFactors user ID for authentication (required) auth_password: SuccessFactors password for authentication (required) department: Filter by department top: Maximum results (default: 100, max: 500)

List terminated employees in a date range for exit processing and compliance.

Args: instance: The SuccessFactors instance/company ID from_date: Start of date range (YYYY-MM-DD) to_date: End of date range (YYYY-MM-DD) data_center: SAP data center code (e.g., 'DC55', 'DC10', 'DC4') environment: Environment type ('preview', 'production', 'sales_demo') auth_user_id: SuccessFactors user ID for authentication (required) auth_password: SuccessFactors password for authentication (required) department: Filter by department top: Maximum results (default: 100, max: 500)

Find employees with incomplete profiles for compliance audits.

Checks for missing email, phone, address, or emergency contact data.

Args: instance: The SuccessFactors instance/company ID check_fields: Comma-separated fields to check: 'email', 'phone', 'address', 'emergency_contact' data_center: SAP data center code (e.g., 'DC55', 'DC10', 'DC4') environment: Environment type ('preview', 'production', 'sales_demo') auth_user_id: SuccessFactors user ID for authentication (required) auth_password: SuccessFactors password for authentication (required) department: Filter by department top: Maximum results (default: 100, max: 500)

Find employees with upcoming work anniversaries for recognition programs.

Args: instance: The SuccessFactors instance/company ID from_date: Start of anniversary search range (YYYY-MM-DD) to_date: End of anniversary search range (YYYY-MM-DD) data_center: SAP data center code (e.g., 'DC55', 'DC10', 'DC4') environment: Environment type ('preview', 'production', 'sales_demo') auth_user_id: SuccessFactors user ID for authentication (required) auth_password: SuccessFactors password for authentication (required) milestone_years_only: If True, only show 1, 5, 10, 15, 20, 25+ year milestones department: Filter by department top: Maximum results (default: 100, max: 500)

Track performance review form completion across the organization.

Args: instance: The SuccessFactors instance/company ID data_center: SAP data center code (e.g., 'DC55', 'DC10', 'DC4') environment: Environment type ('preview', 'production', 'sales_demo') auth_user_id: SuccessFactors user ID for authentication (required) auth_password: SuccessFactors password for authentication (required) form_template_id: Filter by form template ID department: Filter by department (applied client-side) manager_id: Filter by manager's user ID (applied client-side) status: Filter by form status: 'not_started', 'in_progress', 'completed', or '' for all top: Maximum results (default: 100, max: 500)

Get compensation breakdown for employees including base pay and pay components.

Args: instance: The SuccessFactors instance/company ID user_ids: Employee user ID(s) - single ID or comma-separated (max 20) data_center: SAP data center code (e.g., 'DC55', 'DC10', 'DC4') environment: Environment type ('preview', 'production', 'sales_demo') auth_user_id: SuccessFactors user ID for authentication (required) auth_password: SuccessFactors password for authentication (required) effective_date: Show compensation as of this date (YYYY-MM-DD). Defaults to latest.