Artifact locks

An edit lock marks an artifact as being edited by one user, so that two users do not overwrite each other’s work. Lock tools let an AI assistant check who is already editing an artifact, lock an artifact while it works on it, and remove the lock afterwards. The same locks are shown in the Lock Entries tool of the Cockpit.

For artifact types that use edit locks, saving, deleting, or activating an artifact through the MCP server respects a lock that another user holds. The call fails with an error that names the lock and the time since when it has been held.

Required role: locking.

Remove a lock that another user holds

delete_lock also removes a lock that another user holds. In that case, the removal is written to the audit log with the object type Lock, and the response names the user who held the lock and since when.

A lock protects changes that its holder has not saved yet. Remove another user’s lock only after you have agreed on it with that user.

Available tools

Tool Description Parameters

list_locks

List the edit locks that are currently held, newest first. Without field selection, each entry contains id, objectType, objectID, objectKey, createdBy, and createdAt.

listOptions (object, optional). Fields: objectType, objectID, objectKey, createdBy, createdAt, updatedAt.

create_lock

Lock an artifact for editing by you. The response has the status locked, or already held by you if you already hold the lock. If another user holds the lock, the call fails with an error that names the user and since when the lock has been held.

objectType (string): The type of artifact to lock.

objectID (string): The UUID of the artifact to lock.

objectKey (string, optional): The name of the artifact, shown in lock messages.

delete_lock

Remove the lock on an artifact. If you hold the lock, it is released. If another user holds it, it is removed and the removal is audited. If the artifact is not locked, nothing happens.

objectType (string): The type of the locked artifact.

objectID (string): The UUID of the locked artifact.