Skip to main content
Glama
moneyforward-i

Admina MCP Server

delete_identity

Delete an identity by ID. Returns the deleted identity.

Instructions

Delete an identity by ID. Returns the deleted identity.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
identityIdYesThe ID of the identity to delete

Implementation Reference

  • Zod schema and type definition for the delete_identity tool. Requires identityId (string).
    import { z } from "zod";
    import { getClient } from "../admina-api.js";
    
    export const DeleteIdentitySchema = z.object({
      identityId: z.string().describe("The ID of the identity to delete"),
    });
    
    export type DeleteIdentityParams = z.infer<typeof DeleteIdentitySchema>;
    
    export async function deleteIdentity(params: DeleteIdentityParams) {
      const client = getClient();
      return client.makeDeleteApiCall(`/identity/${params.identityId}`);
    }
  • The handler function that executes the delete logic by making a DELETE API call to /identity/{identityId}.
    export async function deleteIdentity(params: DeleteIdentityParams) {
      const client = getClient();
      return client.makeDeleteApiCall(`/identity/${params.identityId}`);
    }
  • src/index.ts:183-187 (registration)
    Registration of the 'delete_identity' tool with description and input schema in the tool list.
    {
      name: "delete_identity",
      description: "Delete an identity by ID. Returns the deleted identity.",
      inputSchema: zodToJsonSchema(DeleteIdentitySchema),
    },
  • src/index.ts:310-311 (registration)
    Handler mapping that routes the 'delete_identity' tool to the deleteIdentity function, parsing input via DeleteIdentitySchema.
    update_identity: async (input) => updateIdentity(UpdateIdentitySchema.parse(input)),
    delete_identity: async (input) => deleteIdentity(DeleteIdentitySchema.parse(input)),
Behavior2/5

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

No annotations provided, so the description must disclose behavior. It mentions it returns the deleted identity but does not state whether deletion is reversible, auditable, or requires specific permissions. The behavioral disclosure is minimal.

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?

The description is a single, front-loaded sentence that conveys the essential action and result with no unnecessary words.

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

Completeness3/5

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

Given the tool's simplicity (one required parameter, no output schema), the description is minimally adequate but fails to mention potential side effects or error conditions that might be important without annotations.

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 coverage is 100% and the schema already describes the parameter. The description does not add any extra meaning beyond what the schema states, so baseline 3 is appropriate.

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 action 'delete an identity by ID' and mentions the return value, distinguishing it from sibling tools like archive_identity, update_identity, or merge_identities.

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

Usage Guidelines2/5

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

No guidance on when to use delete vs other operations (e.g., archive or unregister), nor any prerequisites or exclusions. The agent must infer usage from the name alone.

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