Skip to main content
Glama

list_entities

Discover available OData entities in SuccessFactors to understand queryable data. Fetch entity sets from service documents using instance credentials and optional category filters.

Instructions

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

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
instanceYes
data_centerYes
environmentYes
auth_user_idYes
auth_passwordYes
categoryNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden. It discloses that this is a read operation ('fetches the service document'), but lacks details on authentication behavior, rate limits, error handling, or what 'service document' entails. It adds some context about being a discovery tool but misses key behavioral traits for a tool with authentication parameters.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is appropriately sized and front-loaded with the core purpose in the first sentence. The Args and Returns sections are structured for clarity. Minor redundancy exists (e.g., 'SuccessFactors' repeated), but overall it's efficient with zero wasted sentences.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (6 params, authentication, discovery function) and no annotations, the description does well: it explains purpose, parameters, and return values. However, with an output schema present, the Returns section is somewhat redundant. It lacks details on error cases or operational constraints, leaving minor gaps.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must fully compensate. It successfully adds meaning for all 6 parameters: explaining what each represents (e.g., 'SAP data center code', 'Environment type'), providing examples ('DC55', 'preview'), noting requirements ('required'), and detailing the category filter with options and default. This goes well beyond the bare schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose with specific verbs ('List all available OData entities') and resources ('SuccessFactors instance'), distinguishing it from sibling tools that focus on specific data queries (e.g., query_odata, get_employee_profile). It explicitly identifies this as a 'discovery tool' for understanding available data.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides clear context for when to use this tool ('helps users understand what data is available to query'), but does not explicitly state when not to use it or name specific alternatives. It implies usage for discovery before querying, but lacks explicit exclusions or comparisons to siblings like query_odata.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/aiadiguru2025/sf-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server