Skip to main content
Glama
moneyforward-i

Admina MCP Server

get_identity_history

Retrieve the change history of an identity, including field-level changes, action types, sources, and actors. Paginated results for easy browsing.

Instructions

Get the change history of a specific identity. Returns a paginated list of history records showing field-level changes, action types, sources, and actors.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
identityIdYesThe ID of the identity to retrieve history for
limitNoMaximum number of history items to return per page. Defaults to 10.
cursorNoBase64-encoded cursor for pagination

Implementation Reference

  • Main handler function that calls the Admina API at `/identity/{identityId}/history` with optional query params for pagination (limit, cursor).
    export async function getIdentityHistory(params: GetIdentityHistoryParams) {
      const client = getClient();
      const { identityId, ...rest } = params;
      const queryParams = filtersToParams(rest);
      return client.makeApiCall(`/identity/${identityId}/history`, queryParams);
    }
  • Zod schema defining input parameters: identityId (required string), limit (optional positive integer, default 10), cursor (optional base64 string for pagination).
    export const GetIdentityHistorySchema = z.object({
      identityId: z.string().describe("The ID of the identity to retrieve history for"),
      limit: z
        .number()
        .int()
        .positive()
        .optional()
        .describe("Maximum number of history items to return per page. Defaults to 10."),
      cursor: z.string().optional().describe("Base64-encoded cursor for pagination"),
    });
  • src/index.ts:255-258 (registration)
    Tool registration in the list of available tools with name 'get_identity_history', description, and JSON schema.
    name: "get_identity_history",
    description:
      "Get the change history of a specific identity. Returns a paginated list of history records showing field-level changes, action types, sources, and actors.",
    inputSchema: zodToJsonSchema(GetIdentityHistorySchema),
  • src/index.ts:325-325 (registration)
    Tool handler registration mapping 'get_identity_history' to the getIdentityHistory function with schema parsing.
    get_identity_history: async (input) => getIdentityHistory(GetIdentityHistorySchema.parse(input)),
  • Utility function filtersToParams used to convert the optional params (limit, cursor) into URL query parameters.
    export function filtersToParams(filters: Record<string, any>): URLSearchParams {
      const queryParams = new URLSearchParams();
    
      Object.entries(filters).forEach(([key, value]) => {
        if (value !== undefined && value !== null && !(Array.isArray(value) && value.length === 0)) {
          if (Array.isArray(value) && value.length > 0) {
            // Append each array value separately to generate format: key=value1&key=value2
            value.forEach((item) => {
              queryParams.append(key, String(item));
            });
          } else if (typeof value === "boolean") {
            queryParams.append(key, value.toString());
          } else {
            queryParams.append(key, String(value));
          }
        }
      });
      return queryParams;
    }
Behavior3/5

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

No annotations are present, so the description carries the burden. It discloses paginated nature and record contents but omits behavioral traits like permissions, rate limits, or mutability status. The name 'get' suggests read-only, but this is not explicit.

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 concise sentences with front-loaded purpose. No redundant or extraneous information.

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?

The description covers the return value (field-level changes, action types, sources, actors) and pagination. With no output schema, it provides sufficient context for usage. It could mention the required identityId more explicitly, but schema covers it.

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 baseline is 3. The description adds no additional meaning beyond the schema; it mentions pagination but that is already implied by the cursor and limit parameters.

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 retrieves change history for a specific identity and lists the types of information returned (field-level changes, action types, sources, actors). It distinguishes from sibling tools like get_identity (current state) or update_identity (modifications).

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

Usage Guidelines3/5

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

The description implies usage for retrieving history but does not explicitly state when to use versus alternatives, nor does it provide exclusion criteria or specific use cases.

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/moneyforward-i/admina-mcp-server'

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