Skip to main content
Glama

SmartHR MCP by usefulapi

smarthr_list_employee_custom_fields

Read-only

List the definitions of the tenant's custom employee fields (カスタム従業員項目): name, type and, for dropdowns, the choices. Use them to read the values in custom_fields.

Input Schema

NameRequiredDescriptionDefault
pageNoPage number, 1-based (default 1). Use next_page from the previous reply.
embedNoEmbed the custom field group instead of only its id.
per_pageNoResults per page, 1-100 (default 50).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior3/5

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

readOnlyHint=true already declares the safety profile, so the description's added value is the return shape (name, type, dropdown choices) and tenant scoping. It does not mention pagination behavior or the effect of the embed parameter, though the schema covers those.

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

Conciseness5/5

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

Two short sentences, front-loaded with the verb and resource, followed by the one usage hint that matters. Nothing redundant.

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?

With no output schema, the description does describe the returned fields, which is the key need for a read-only listing tool. Minor remaining gap: it does not mention paging or the grouped-vs-flat effect of embed, though the parameter schema documents both.

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

Parameters3/5

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

Schema description coverage is 100%, so page, embed and per_page are already fully documented in the schema. The description adds nothing about them, which is the baseline 3 case where structured data does the heavy lifting.

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?

States a specific verb and a precisely scoped resource: 'List the definitions of the tenant's custom employee fields,' and even enumerates what a definition contains (name, type, dropdown choices). This cleanly distinguishes it from sibling list tools such as smarthr_list_employees, which return records rather than schema definitions.

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?

'Use them to read the values in custom_fields' gives a concrete when-to-use condition tied to interpreting employee data. It stops short of naming an alternative or stating exclusions, but the context for calling it is clear.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.