SuccessFactors MCP Server
Provides tools for interacting with SAP SuccessFactors OData API to retrieve and update employee/user data, manager and HR assignments, and user statistics.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@SuccessFactors MCP Serverget user data for employee 1001"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
SuccessFactors MCP Server
An MCP (Model Context Protocol) server for interacting with SAP SuccessFactors OData API to retrieve and update employee/user data.
Features
get_user_data: Retrieve employee data with all specified fields
post_user_data: Update employee/user information
get_user_statistics: Get aggregate statistics about all users
search_user_by_email: Find users by email and return userId/firstName/lastName/email
manage_user_fields: Get or update all 47 standard user fields (comprehensive field management)
get_complete_employee_data: Retrieve complete employee data with all navigation properties (full OData entry)
get_manager_hr: Retrieve manager and/or HR information
update_user_odata: Update user data using the upsert endpoint with exact OData format (camelCase fields). WARNING: This operation will modify employee data in the SAP SuccessFactors system. Changes cannot be automatically undone.
update_manager_hr: Update manager and/or HR assignments. WARNING: This operation will modify employee data in the SAP SuccessFactors system. Changes cannot be automatically undone.
Related MCP server: SF-MCP
Setup
Install dependencies:
npm installBuild the project:
npm run buildRun the server:
npm startFor development with auto-reload:
npm run devConfiguration
All sensitive configuration (API URL, username, and password) is stored in a .env file.
Copy the example file:
copy .env.example .envEdit the
.envfile with your credentials:
SF_API_URL=https://apisalesdemo2.successfactors.eu/odata/v2
SF_USERNAME=your-username-here
SF_PASSWORD=your-password-hereImportant: The .env file is already in .gitignore and will not be committed to version control. Always keep your credentials secure!
MCP Client Configuration
To use this server with an MCP client (like Claude Desktop), add it to your MCP configuration file:
{
"mcpServers": {
"successfactors": {
"command": "node",
"args": ["C:\\Users\\Desktop\\SF-MCP-01\\dist\\index.js"]
}
}
}Available Tools
get_user_data
search_user_by_email
Search users by email and return basic identity info.
Parameters:
email(required): Email address to search (exact match)
Returns: Array of matches with userId, firstName, lastName, and email.
Example request (OData): GET /odata/v2/User?$filter=email eq 'user.email@example.com'
Retrieves employee/user data from SuccessFactors.
Parameters:
userId(required): User ID (USERID), Employee ID (EMPID), or Email addressfields(optional): Array of specific fields to retrieve. If not provided, returns all standard fields.
Returns: JSON object with user data including:
STATUS, USERID, USERNAME, FIRSTNAME, LASTNAME, MI, GENDER, EMAIL
MANAGER, HR, DEPARTMENT, JOBCODE, DIVISION, LOCATION, TIMEZONE
HIREDATE, EMPID, TITLE, BIZ_PHONE, FAX
ADDR1, ADDR2, CITY, STATE, ZIP, COUNTRY
REVIEW_FREQ, LAST_REVIEW_DATE
CUSTOM01 through CUSTOM15
MATRIX_MANAGER, DEFAULT_LOCALE, PROXY
CUSTOM_MANAGER, SECOND_MANAGER, LOGIN_METHOD
PERSON_GUID, PERSON_ID_EXTERNAL
post_user_data
Updates employee/user data in SuccessFactors.
Parameters:
userId(required): User ID to updatedata(required): Object containing key-value pairs of fields to update
Returns: Confirmation of successful update with updated fields list.
Implementation detail: This operation uses the SuccessFactors upsert endpoint: POST /upsert?purgeType=record.
get_user_statistics
Retrieves aggregate statistics about all users.
Parameters:
filters(optional): Object with filters for statistics
Returns: Statistics including:
Total users count
Active/inactive users
Breakdown by gender, department, location, and status
get_manager_hr
Retrieves manager and/or HR information for a specific user.
Parameters:
userId(required): User ID (USERID), Employee ID (EMPID), or Email address to querygetManager(optional): Whether to retrieve manager information (default: true)getHR(optional): Whether to retrieve HR information (default: true)
Returns: JSON object with:
User ID information
Manager details (userId, username, firstName, lastName, email) if requested
HR details (userId, username, firstName, lastName, email) if requested
null values if manager/HR is not assigned
update_manager_hr
Updates manager and/or HR assignment for a user.
Parameters:
userId(required): User ID to updatemanagerId(optional): New manager User ID to assign (can be USERID, EMPID, or EMAIL)hrId(optional): New HR User ID to assign (can be USERID, EMPID, or EMAIL)
Note: At least one of managerId or hrId must be provided.
Returns: Confirmation of successful update with assigned manager/HR IDs.
manage_user_fields
Get or update all standard user fields in SuccessFactors. This is a comprehensive tool that supports all 47 standard fields.
Parameters:
action(required): Either"get"to retrieve fields or"update"to modify fieldsuserId(required): User ID (USERID), Employee ID (EMPID), or Email addressfields(optional):For
"get"action: Object specifying which fields to retrieve (keys are field names). If not provided, returns all fields.For
"update"action: Required - Object containing field names and values to update (e.g.,{"FIRSTNAME": "John", "LASTNAME": "Doe"})
Supported Fields (all 47 fields): STATUS, USERID, USERNAME, FIRSTNAME, LASTNAME, MI, GENDER, EMAIL, MANAGER, HR, DEPARTMENT, JOBCODE, DIVISION, LOCATION, TIMEZONE, HIREDATE, EMPID, TITLE, BIZ_PHONE, FAX, ADDR1, ADDR2, CITY, STATE, ZIP, COUNTRY, REVIEW_FREQ, LAST_REVIEW_DATE, CUSTOM01 through CUSTOM15, MATRIX_MANAGER, DEFAULT_LOCALE, PROXY, CUSTOM_MANAGER, SECOND_MANAGER, LOGIN_METHOD, PERSON_GUID, PERSON_ID_EXTERNAL
Returns:
For
"get": All requested fields with their current values (null if not set), plus list of all available fieldsFor
"update": Confirmation with list of updated fields and their new values
Implementation detail: The update action uses the SuccessFactors upsert endpoint: POST /upsert?purgeType=record.
get_complete_employee_data
Retrieve complete employee data with all fields and navigation properties. This returns the full OData entry as returned by SuccessFactors API, similar to fetching User('empId') directly. Useful for getting comprehensive employee information including all available navigation links and expanded properties.
Parameters:
userId(required): User ID (USERID), Employee ID (EMPID), or Email addressexpandProperties(optional): Array of navigation properties to expand (e.g.,["personKeyNav", "manager", "hr", "empInfo"]). If not provided, defaults to common properties: personKeyNav, manager, hr, empInfo, secondManager, matrixManager, customManager.format(optional): Response format -"json"(default) or"xml". XML format returns the raw OData XML entry.
Returns:
Complete employee data structure with all fields and navigation properties
For JSON format: Structured object with completeData field containing all employee information
For XML format: Raw OData XML entry (similar to the example provided)
update_user_odata
Update user data using the SuccessFactors upsert endpoint with exact OData format matching SuccessFactors API. Accepts fields in camelCase format (firstName, lastName, email, status, timeZone, etc.) and automatically formats manager and HR with proper __metadata structure.
Parameters:
userId(required): User ID to update (internal user ID)username(optional): Username (defaults to userId if not provided)status(optional): User status (e.g., "t" for active)firstName(optional): First namelastName(optional): Last namegender(optional): Gender (M/F)email(optional): Email addressdepartment(optional): DepartmenttimeZone(optional): Time zone (e.g., "US/Eastern", "Asia/Jerusalem")managerId(optional): Manager User ID, or "NO_MANAGER" to remove managerhrId(optional): HR User ID, or "NO_HR" to remove HRadditionalFields(optional): Object with additional fields in camelCase format
Returns: Confirmation with the complete payload that was sent and the API response.
Implementation detail: This tool performs POST /upsert?purgeType=record with a SFOData.User payload.
Notes
WARNING - DEMONSTRATION PURPOSES ONLY
This code is NOT PRODUCTION-READY and has been created solely for DEMONSTRATION AND TESTING PURPOSES.
Do not use this in a live production environment.
Before deploying to production, ensure proper development, testing, security review, and compliance with all relevant standards and regulations.
WARNING: This operation will modify employee data in the SAP SuccessFactors system. Changes cannot be automatically undone.
The server uses Basic Authentication with the provided credentials
Available Tools
9 toolsget_complete_employee_dataA
Retrieve complete employee data with all fields and navigation properties (personKeyNav, manager, hr, empInfo, etc.). Returns the full OData entry as returned by SuccessFactors API, similar to fetching User('empId') with all expansions.
| Name | Required | Description | Default |
|---|---|---|---|
| format | No | Response format: "json" (default) or "xml" | json |
| userId | Yes | User ID (USERID), Employee ID (EMPID), or Email address | |
| expandProperties | No | Optional: List of navigation properties to expand (e.g., ["personKeyNav", "manager", "hr", "empInfo"]). If not provided, will attempt to get common navigation properties. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the safety/disclosure burden. It discloses the return shape (full OData entry, all fields/navigation properties) and the fetch behavior, which is useful. However, it does not state permissions/auth requirements, error behavior, or any performance caveats for a complete-data fetch.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two tight sentences; the first delivers the function and scope, the second gives an implementation analogy. No filler or repeated structured data.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given no output schema, the description adequately describes the return value and what 'complete' means. It could be more complete with permission/error context and an explicit pointer to lighter-weight sibling tools, but for calling the tool the essentials are present.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the baseline is 3; the tool description adds essentially no parameter-level detail beyond the schema. The 'all expansions' phrase slightly clarifies expandProperties, but userId, format, and expandProperties are already fully documented in the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Description uses a specific verb ('Retrieve') and a precise resource ('complete employee data'), enumerates the relevant navigation properties, and anchors the behavior to an OData User('empId') fetch with all expansions. This clearly distinguishes it from siblings like get_manager_hr or get_user_data, even though those tools are not named.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No explicit when/when-not guidance or named alternatives are provided. The description implies that this is the tool for complete data, but it does not explain when to prefer get_user_data or get_manager_hr for narrower requests. Sibling tool names exist, so this is a missed opportunity.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_manager_hrB
Retrieve manager and/or HR information for a specific user in SuccessFactors.
| Name | Required | Description | Default |
|---|---|---|---|
| getHR | No | Whether to retrieve HR information (default: true) | |
| userId | Yes | User ID (USERID), Employee ID (EMPID), or Email address to query | |
| getManager | No | Whether to retrieve manager information (default: true) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries full burden. The verb 'Retrieve' implies a read-only operation, which is useful but minimal. It does not disclose edge cases like what happens when both getHR and getManager are false, response format, or error behavior.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, front-loaded sentence with no filler. It conveys the core action and scope immediately and efficiently.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool is simple and the schema covers parameters well, but the description alone doesn't fully equip an agent to select it with confidence. It lacks usage routing and details about what the returned 'manager and/or HR information' contains, especially since there is no output schema.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the schema already documents all three parameters with descriptions and defaults. The tool description adds no additional meaning beyond the schema, matching the baseline.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb ('Retrieve') and resource ('manager and/or HR information') for a specific user in SuccessFactors. It is clear and distinct from sibling names like update_manager_hr, though it doesn't explicitly differentiate from get_complete_employee_data or get_user_data.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance is provided about when to use this tool versus alternatives. It doesn't mention, for example, that get_complete_employee_data or get_user_data might be more appropriate for broader data needs, nor does it state any exclusions or prerequisites.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_user_dataA
Retrieve employee/user data from SuccessFactors. Returns specified fields for a user by USERID, EMPID, or EMAIL.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Optional: Specific fields to retrieve. If not provided, returns all standard fields. | |
| userId | Yes | User ID (USERID), Employee ID (EMPID), or Email address to query |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the burden of behavioral disclosure. 'Retrieve' and 'Returns' clearly indicate a read-only lookup with no side effects, but it does not disclose permissions, error behavior, or what happens when no user is found. The main behavioral trait is adequately conveyed, though not richly.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, front-loaded sentence with no wasted words. It states the resource, action, and key parameters in a tight format that is easy to parse.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple two-parameter read operation, the description covers the core need, but it lacks guidance on selecting among siblings and does not describe the response shape or behavior when 'fields' is omitted. No output schema exists to fill that gap.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%: the schema already documents both fields and userId with the same USERID/EMPID/EMAIL clarification. The description therefore adds no parameter meaning beyond what an agent can already see in the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a specific verb ('Retrieve') with a clear resource ('employee/user data from SuccessFactors') and further scopes the operation by identifier type (USERID, EMPID, EMAIL) and return behavior (specified fields). This makes it distinguishable from siblings like get_complete_employee_data (full vs specified fields) and search_user_by_email (exact identifier lookup vs search).
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies this is the right tool when you have an exact user identifier and want selected data, but it never explicitly states when to prefer it over sibling tools such as search_user_by_email or get_complete_employee_data. There are no exclusions or alternative conditions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_user_statisticsA
Get aggregate statistics about all users in SuccessFactors (total count, active users, etc.)
| Name | Required | Description | Default |
|---|---|---|---|
| filters | No | Optional filters for statistics (e.g., {status: "A"}) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the behavioral disclosure burden. It does state the aggregate, all-user scope and gives examples of returned statistics, but it does not explain the output structure, how filters alter results, or error/access behavior.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single focused sentence that front-loads the action and resource, includes useful examples, and contains no filler or redundant information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With only one optional parameter and no annotations, the description covers the core invocation but leaves the exact shape of the returned statistics and the effect of filters unspecified. Since there is no output schema, a bit more return-value detail would improve completeness.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, and the schema already documents the optional filters parameter with an example. The tool description adds no additional parameter semantics beyond 'total count, active users, etc.,' so it meets but does not exceed the baseline.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a specific verb and resource: 'Get aggregate statistics about all users in SuccessFactors,' with concrete examples like total count and active users. It is clear enough to separate from sibling tools that fetch individual user data, although it does not explicitly name an alternative.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies the tool is for aggregate user counts and statistics, so an agent can infer when it is appropriate. However, it gives no explicit guidance about when not to use it or which sibling tool to use instead for individual user retrieval.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
manage_user_fieldsC
Get or update all standard user fields in SuccessFactors. Supports all 47 standard fields including STATUS, USERID, USERNAME, FIRSTNAME, LASTNAME, MI, GENDER, EMAIL, MANAGER, HR, DEPARTMENT, JOBCODE, DIVISION, LOCATION, TIMEZONE, HIREDATE, EMPID, TITLE, BIZ_PHONE, FAX, ADDR1, ADDR2, CITY, STATE, ZIP, COUNTRY, REVIEW_FREQ, LAST_REVIEW_DATE, CUSTOM01-CUSTOM15, MATRIX_MANAGER, DEFAULT_LOCALE, PROXY, CUSTOM_MANAGER, SECOND_MANAGER, LOGIN_METHOD, PERSON_GUID, and PERSON_ID_EXTERNAL.
| Name | Required | Description | Default |
|---|---|---|---|
| action | Yes | Action to perform: "get" to retrieve fields, "update" to modify fields | |
| fields | No | Required for "update" action: Object containing field names and values to update. Keys should be uppercase field names (e.g., {"FIRSTNAME": "John", "LASTNAME": "Doe"}). Optional for "get" action: specify which fields to retrieve, otherwise all fields are returned. | |
| userId | Yes | User ID (USERID), Employee ID (EMPID), or Email address |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden of behavioral disclosure. It reveals that updates are possible, but it does not mention side effects, permissions required, whether updates are partial or full replacements, reversibility, or any write-operation cautions. This is a meaningful gap for a mutation-capable tool.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The opening sentence is clear and front-loaded, but the massive list of 47 field names makes the description long and unstructured. The list is informative and relevant, yet it could be better organized (e.g., grouped or abbreviated) without losing value.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool has no output schema and no annotations, so the description must cover more than it does. It explains the input scope well, but it omits return values, error behavior, authentication needs, and update side effects. An agent is left without important context for safely invoking and interpreting this tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline is 3. The description adds a useful enumeration of valid field names for the 'fields' parameter, but it does not add meaning beyond what the schema already provides for 'action' or 'userId'. It supplements the schema without significantly extending it.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the action ('Get or update') and the resource ('all standard user fields in SuccessFactors'), which is specific enough to distinguish it from siblings focused on manager/HR data or search. However, it does not explicitly name or contrast sibling tools, so it stops short of a 5.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance is given about when to use this tool versus siblings like get_user_data, post_user_data, or update_user_odata. The description implies it is for standard user fields, but it never states exclusions, prerequisites, or when another tool would be more appropriate.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_user_dataB
Update or create employee/user data in SuccessFactors. Note: Creating new users may require additional permissions.
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | User data fields to update (key-value pairs) | |
| userId | Yes | User ID to update |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the burden of disclosing behavior. It does reveal that the tool mutates data and can create new records, and it adds a useful permission caveat. However, it does not describe side effects, failure behavior, whether existing data is overwritten or merged, or what the response looks like.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short sentences with no filler: the first states the core purpose and the second adds a necessary caveat. The information is front-loaded and every sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool has no annotations and no output schema, and the description leaves important ambiguity around the create/update trigger, required permissions, and response behavior. An agent cannot safely determine how to create a user versus update one, making the definition incomplete for confident invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents both parameters. The description adds no parameter-specific semantics; notably, it does not clarify how 'create' works when the schema only provides userId and data, which is a meaningful gap.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a clear action ('Update or create') and a specific resource ('employee/user data in SuccessFactors'). However, the dual update/create scope is slightly ambiguous and it does not differentiate itself from sibling tools like update_user_odata.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no guidance on when to use this tool versus alternatives such as update_user_odata, manage_user_fields, or the get_* tools. The permission note hints that creating users is special, but it does not explain when this tool is preferred or should be avoided.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
search_user_by_emailA
Search users by email and return basic identity info (userId, firstName, lastName, email).
| Name | Required | Description | Default |
|---|---|---|---|
| Yes | Email address to search (exact match) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the burden of behavioral disclosure. It clearly conveys a read-only search that returns basic identity fields, but it does not mention exact-match behavior, authorization needs, or what happens when no user is found. For a simple search tool this is adequate but not richly transparent.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single front-loaded sentence with no filler. Every word earns its place by stating the operation, the resource, and the expected return fields.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a one-parameter lookup with no annotations and no output schema, the description sufficiently covers the input basis and output shape. It could additionally mention not-found behavior or point to sibling tools for richer data, but those are secondary for this simple tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, with the email parameter already described as 'Email address to search (exact match)'. The description's phrase 'by email' adds no meaningful semantic detail beyond what the schema already provides, so the baseline of 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a specific verb ('Search'), names the resource ('users by email'), and lists the returned identity fields, making it easy for an agent to distinguish this read-only lookup from siblings like update_manager_hr or get_user_statistics.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies when to use the tool: when you need to find a user by email and obtain basic identity info. However, it does not explicitly say when not to use it or point to alternatives such as get_user_data or get_complete_employee_data for richer user information.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
update_manager_hrB
Update manager and/or HR assignment for a user in SuccessFactors.
| Name | Required | Description | Default |
|---|---|---|---|
| hrId | No | Optional: New HR User ID to assign | |
| userId | Yes | User ID to update | |
| managerId | No | Optional: New manager User ID to assign |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description alone must disclose behavior. It only says it updates assignments, which is already clear from the name. It does not mention whether the update is partial or full, whether existing assignments are overwritten, required permissions, or any side effects. There is no contradiction with annotations, but minimal behavioral detail.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single sentence that is front-loaded with the action and wastes no words. It is maximaly concise while still conveying the core purpose.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple mutation tool with full schema coverage, the description covers the essential intent: updating manager and/or HR assignment for a user. However, without annotations or an output schema, it does not clarify expected response behavior, constraints, or whether both fields can be updated in one call. It is barely adequate but not complete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline is 3. The phrase 'and/or' hints that either managerId or hrId can be provided, but the schema already communicates the optionality clearly. No additional parameter semantics are added by the description.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses the specific verb 'update' and identifies the exact resource: manager and/or HR assignment for a user in SuccessFactors. It is clear and unambiguous, though it does not explicitly differentiate itself from sibling tools like update_user_odata, so it misses the top score.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No when-to-use guidance is provided. The description gives no indication of when this tool should be chosen over siblings like get_manager_hr or update_user_odata, nor does it state any exclusions or prerequisites. Usage must be inferred entirely from the tool name.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
update_user_odataA
Update user data using PUT request with exact OData format. Accepts fields in camelCase format (matching SuccessFactors API format) such as firstName, lastName, email, status, timeZone, etc. Manager and HR should be provided as User IDs or "NO_MANAGER"/"NO_HR".
| Name | Required | Description | Default |
|---|---|---|---|
| hrId | No | HR User ID, or "NO_HR" to remove HR | |
| No | Email address | ||
| gender | No | Gender (M/F) | |
| status | No | User status (e.g., "t" for active) | |
| userId | Yes | User ID to update (internal user ID) | |
| lastName | No | Last name | |
| timeZone | No | Time zone (e.g., "US/Eastern", "Asia/Jerusalem") | |
| username | No | Username (optional, defaults to userId if not provided) | |
| firstName | No | First name | |
| managerId | No | Manager User ID, or "NO_MANAGER" to remove manager | |
| department | No | Department | |
| additionalFields | No | Additional fields in camelCase format (e.g., {"jobCode": "Employee", "location": "Israel"}) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description must carry the behavioral burden. It usefully discloses the HTTP method (PUT) and the exact OData/camelCase format, which is more than the tool name alone provides. However, it does not state whether the PUT is a partial update or full replacement, how omitted fields are treated, what authorization is required, or what response/error behavior to expect.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is three concise sentences, each earning its place: the first states the operation and method, the second covers field formatting, and the third explains special sentinel values for manager and HR. It is front-loaded with the most important scope and avoids redundancy.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The schema is rich and fully documented, but there is no output schema and no annotations. The description covers the API format and sentinel values, yet it omits crucial write-operation context such as whether unspecified fields are preserved or reset, permissions, and expected response/error behavior. For a complex 12-parameter mutation tool, this is a noticeable but not fatal gap.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the baseline is 3. The description adds value by explaining that fields should be in camelCase matching the SuccessFactors API and by naming representative fields such as firstName, lastName, and timeZone. This gives cross-parameter context that the schema descriptions do not provide individually.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states a specific action and resource: updating user data via a PUT request with exact OData format. It also communicates the camelCase SuccessFactors style, making the tool's role understandable, but it does not explicitly distinguish it from siblings like post_user_data or update_manager_hr.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies a use case—updating user data through OData-formatted PUT calls—and gives format guidance, but it provides no explicit when-to-use vs. when-not-to-use guidance or references to alternatives such as update_manager_hr or post_user_data. The manager/HR sentinel values hint at coverage, but they are parameter semantics, not tool-selection guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
9 tool updates
v1.0.0- First observed
get_complete_employee_data - First observed
get_manager_hr - First observed
get_user_data - First observed
get_user_statistics - First observed
manage_user_fields - First observed
post_user_data - First observed
search_user_by_email - First observed
update_manager_hr - First observed
update_user_odata
TDQS
Scored across 9 tools
Several tools overlap in purpose: get_user_data, get_complete_employee_data, and search_user_by_email all retrieve user information at different levels, while post_user_data, manage_user_fields, and update_user_odata all provide ways to create or update user records. The descriptions clarify some boundaries, but an agent would struggle to confidently choose among these overlapping options.
Tool names mostly follow a consistent verb_noun pattern in snake_case (update_manager_hr, get_user_data, search_user_by_email). Minor deviations like post_user_data and manage_user_fields break the get/update pattern but the overall style remains predictable.
Nine tools is a reasonable count for a SuccessFactors user-management server and stays within the well-scoped range. The count is slightly high because several tools cover similar operations, so not every tool is clearly indispensable.
The set covers core user lifecycle operations: retrieval, lookup by email, statistics, and multiple update paths including manager/HR changes. It lacks explicit delete/list operations, but for an HR system those are often handled via status updates, so agents can work around the minor gaps.
Maintenance
Related MCP Connectors
MCP server providing attendance data queries via the CloudTime API.
MCP server for Product Management
An MCP server that provides an API to LLMs to manage their JumpCloud resources.
MCP server for the Seline Analytics API
Related MCP Servers
- Apache 2.0
- AlicenseAqualityCmaintenanceEnables querying SAP SuccessFactors OData API metadata and managing Role-Based Permission (RBP) configurations. It provides tools for retrieving entity metadata, listing permission roles, and inspecting user-specific access rights through MCP-compatible clients.2911MIT
- AlicenseNot gradedqualityBmaintenanceMCP server for SAP S/4HANA via the ADT API, enabling querying and reading SAP systems with production write protection.2 npmMIT
- AlicenseBqualityCmaintenanceAn MCP server that provides tools to list, get, create, and update SAP S/4HANA Cloud Public Edition business objects like purchase orders, sales orders, and production orders through the Model Context Protocol.58GPL 3.0