machship-mcp

Update Identity

machship_update_identity

Update an identity's required profile fields (first/last/display name, email, owning company) and optional password or contact details; omitted optional fields are set to null.

Instructions

Updates properties on an identity. All fields except password are required; omitted fields are set to null.

Args:

id (number): Identity ID (required)
givenName (string): First name (required)
familyName (string): Last name (required)
displayName (string): Display name (required)
emailAddress (string): Email address (required)
owningCompanyId (number): Owning company ID (required)
password (string, optional): New password
phone / businessPhone / mobile / position / notes (optional)

Input Schema

Name	Required	Description
`id`	Yes	Identity ID
`notes`	No	Additional notes about the identity
`phone`	No	Phone number
`mobile`	No	Mobile number
`password`	No	New password (optional)
`position`	No	Job position or title
`givenName`	Yes	First name
`familyName`	Yes	Last name
`displayName`	Yes	Display name
`emailAddress`	Yes	Email address
`businessPhone`	No	Business phone number
`owningCompanyId`	Yes	Owning company ID

Output Schema

Name	Required	Description	Default
`errors`	No	Validation errors returned by Machship, if any
`object`	No	Response payload from the Machship API

Schema Changelog

Changes observed during successful MCP inspections.

Changed9 schema fields changedv1.0.1Nov 3, 2026

addedInput schema / properties / businessPhone / description
```
Added value: +"Business phone number"
```

addedInput schema / properties / emailAddress / pattern

Added value: +"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"

addedInput schema / properties / id / maximum
```
Added value: +9007199254740991
```
addedInput schema / properties / mobile / description
```
Added value: +"Mobile number"
```

addedInput schema / properties / notes / description

Added value: +"Additional notes about the identity"

addedInput schema / properties / owningCompanyId / maximum
```
Added value: +9007199254740991
```
addedInput schema / properties / phone / description
```
Added value: +"Phone number"
```
addedInput schema / properties / position / description
```
Added value: +"Job position or title"
```

changedOutput schema / (root)

Previous value: -nullNew value: +{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "additionalProperties": {},
+  "properties": {
+    "errors": {
+      "anyOf": [
+        {
+          "items": {},
+          "type": "array"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "description": "Validation errors returned by Machship, if any"
+    },
+    "object": {
+      "description": "Response payload from the Machship API"
+    }
+  },
+  "type": "object"
+}

First observedv1.0.0Jun 12, 2026

TDQS

A3.7/5.0

Behavior4/5

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

Annotations only say readOnlyHint=false, idempotentHint=false, destructiveHint=false, so the description carries the burden of disclosing what actually happens on a write. It does this well: omitting any non-password field silently nulls it out, which is effectively partial data loss that destructiveHint=false does not signal. The gap is that it never states whether providing the same payload twice produces the same result, despite idempotentHint=false, or what a failed update leaves behind.

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 front-loaded sentence contains the one fact that matters most, the null-overwrite rule, before any enumeration. The Args block duplicates the schema and lengthens the definition, but it is clearly structured and contains no filler prose.

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?

An output schema exists, so return values need not be explained, and the required/optional split plus null-fill semantics cover what an agent needs to construct a correct call. Missing is anything about failure modes, such as invalid email format at the API level or a nonexistent id, and confirmation that id refers to an identity from get_identities.

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 the schema already documents all 12 parameters, and the description's Args list largely restates them. Its only added meaning is grouping the optional tail (phone, businessPhone, mobile, position, notes) and flagging password as the sole truly optional field not subject to the null-fill rule, which the schema's 'required' array only partially conveys. Baseline 3 is appropriate.

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

Purpose4/5

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

States a specific verb and resource ('Updates properties on an identity'), which cleanly separates it from machship_create_identities, machship_delete_identities, machship_get_identity and machship_disable_identities in the sibling list. It stops short of naming which sibling to use when, but the operation itself is unambiguous.

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 line 'All fields except password are required; omitted fields are set to null' implicitly tells the agent this is a full replacement rather than a patch, which is a real usage constraint. However, there is no explicit guidance on when to choose this over disable_identities, link_identities_to_companies, or reenable_identities, and no prerequisites such as permissions or which company the identity must belong to.

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

Deploy Server