Reference
Crismo MCP server
Connect an AI assistant to your Crismo workspace. The MCP server exposes 54 tools for reading, analyzing, and editing your process models, value chains, dictionaries, attributes, share links, and milestones. New to MCP? Start with What is an MCP server?
Requirements
- A Crismo workspace with API access enabled (Enterprise plan). This generates the API key the server authenticates with.
- Your tenant ID and an API key (format
crismo_XXXX_...), from your workspace settings. - An MCP-compatible client: Claude Desktop, Cursor, Cline, or Zed.
Get access
The Crismo MCP server is provisioned for Enterprise workspaces. Once API access is enabled on your workspace, we share the server package and the exact command to run it. Talk to us to get set up.
Configure your client
Every MCP client wires the server the same way; only the config file and its location differ. Drop the command we provide into the command/args fields, add your token and tenant ID, then restart the client and it will list the Crismo tools automatically.
Claude Desktop
claude_desktop_config.json
{
"mcpServers": {
"crismo": {
"command": "<command provided by Crismo>",
"env": { "CRISMO_TOKEN": "YOUR_TOKEN", "TENANT_ID": "YOUR_TENANT_ID" }
}
}
}Cursor
~/.cursor/mcp.json (or .cursor/mcp.json in a project)
{
"mcpServers": {
"crismo": {
"command": "<command provided by Crismo>",
"env": { "CRISMO_TOKEN": "YOUR_TOKEN", "TENANT_ID": "YOUR_TENANT_ID" }
}
}
}VS Code
.vscode/mcp.json (note the servers key)
{
"servers": {
"crismo": {
"command": "<command provided by Crismo>",
"env": { "CRISMO_TOKEN": "YOUR_TOKEN", "TENANT_ID": "YOUR_TENANT_ID" }
}
}
}Cline and Zed use the same command in their own MCP settings (cline_mcp_settings.json and Zed settings.json → context_servers).
Tool catalog
54 tools, grouped by resource, each with its input parameters. Read-only tools (list, get, search, compare) are safe to explore; mutating tools (create, patch, update, delete) respect your workspace permissions. This server exposes tools only (no MCP resources or prompts).
Auth (1)
crismo_auth_statusCheck Crismo Cloud authentication status.
Diagrams (7)
crismo_list_diagramsList all BPMN diagrams in the workspace.
crismo_get_diagramGet a BPMN diagram as XML. Read positions, lane bounds, and flow routing before modifying.
diagramId | stringrequired | Diagram ID |
crismo_patch_diagramModify a BPMN diagram with a JSON patch (add/remove/rename/move/reconnect). Server applies and validates.
diagramId | stringrequired | Diagram ID to modify |
patch | objectrequired | JSON Patch (add/remove/reconnect/rename/move) |
author | stringoptional | Who is making the change |
message | stringoptional | Change description |
crismo_create_diagramCreate a new BPMN diagram from a patch definition (add lanes, elements, flows).
name | stringrequired | Name for the new diagram |
patch | objectrequired | Process definition as a patch |
author | stringoptional | Who is creating this |
crismo_delete_diagramDelete a diagram from Crismo Cloud.
diagramId | stringrequired | Diagram ID to delete |
crismo_get_diagram_with_attributesRECOMMENDED FOR ANALYSIS. Returns the compact DSL representation of a diagram annotated inline with every element's attribute values (Duration, Cost, Tool, etc.). Dictionary-typed attributes are resolved to human-readable terms. One call replaces N per-element attribute fetches. Format: element lines end with `{Attr=value, Attr=term}`. Use this instead of calling crismo_get_diagram + N\xD7 crismo_attr_get_element.
diagramId | stringrequired | Diagram ID |
crismo_unlink_diagramRemove a process link from a diagram element.
diagramId | stringrequired | Diagram ID |
elementId | stringrequired | Element ID to unlink |
Process links (2)
crismo_list_linksList process links (drill-down / upstream / downstream) for a diagram.
diagramId | stringrequired | Diagram ID |
crismo_link_diagramLink a diagram element (StartEvent / EndEvent / SubProcess) to another diagram.
diagramId | stringrequired | Source diagram ID |
elementId | stringrequired | Element ID to link |
targetDiagramId | stringrequired | Target diagram ID |
Value chains (13)
crismo_vc_listList all value chains.
crismo_vc_getGet a value chain with its segments.
id | stringrequired | Value chain ID |
crismo_vc_createCreate a value chain.
name | stringrequired | Name |
description | stringoptional | Description |
type | stringoptional · default core | Type |
template | stringoptional | Template ID: saas, manufacturing, hr-people, etc. |
crismo_vc_updateUpdate a value chain (name / description / status).
id | stringrequired | Value chain ID |
name | stringoptional | |
description | stringoptional | |
status | stringoptional |
crismo_vc_deleteDelete a value chain and all its segments.
id | stringrequired | Value chain ID |
crismo_vc_duplicateDuplicate a value chain.
id | stringrequired | Value chain ID to duplicate |
name | stringoptional | Name for the copy |
crismo_vc_templatesList available value chain templates.
crismo_vc_segmentsList segments for a value chain.
vcId | stringrequired | Value chain ID |
crismo_vc_add_segmentAdd a segment to a value chain.
vcId | stringrequired | Value chain ID |
name | stringrequired | Segment name |
parent | stringoptional | Parent segment ID (for nesting) |
color | stringoptional · default blue | Color: blue, green, orange, etc. |
level | stringoptional · default L1 | Level |
crismo_vc_delete_segmentDelete a segment from a value chain.
vcId | stringrequired | Value chain ID |
segId | stringrequired | Segment ID |
crismo_vc_link_diagramLink a diagram to a value chain segment.
vcId | stringrequired | Value chain ID |
segId | stringrequired | Segment ID |
diagramId | stringrequired | Diagram ID to link |
crismo_vc_unlink_diagramUnlink a diagram from a value chain segment.
vcId | stringrequired | Value chain ID |
segId | stringrequired | Segment ID |
diagramId | stringrequired | Diagram ID to unlink |
crismo_vc_contextShow the value chain context for a diagram (which VC/segment it belongs to).
diagramId | stringrequired | Diagram ID |
Dictionaries (11)
crismo_dict_listList all dictionaries.
crismo_dict_getGet a dictionary with all its entries.
id | stringrequired | Dictionary ID |
crismo_dict_createCreate a dictionary.
name | stringrequired | Dictionary name |
description | stringoptional | Description |
crismo_dict_deleteDelete a dictionary and all its entries.
id | stringrequired | Dictionary ID |
crismo_dict_entriesList entries in a dictionary.
dictId | stringrequired | Dictionary ID |
crismo_dict_add_entryAdd an entry to a dictionary.
dictId | stringrequired | Dictionary ID |
term | stringrequired | Entry term |
definition | stringoptional | Definition |
synonyms | stringoptional | Synonym list |
crismo_dict_delete_entryDelete an entry from a dictionary.
dictId | stringrequired | Dictionary ID |
entryId | stringrequired | Entry ID |
crismo_dict_searchSearch dictionary entries by prefix.
dictId | stringrequired | Dictionary ID |
query | stringrequired | Search prefix |
crismo_dict_link_elementLink a diagram element to a dictionary entry.
diagramId | stringrequired | Diagram ID |
elementId | stringrequired | Element ID |
dictId | stringrequired | Dictionary ID |
entryId | stringrequired | Entry ID |
crismo_dict_unlink_elementUnlink a diagram element from a dictionary entry.
diagramId | stringrequired | Diagram ID |
elementId | stringrequired | Element ID |
entryId | stringrequired | Entry ID |
crismo_dict_entry_usagesShow where a dictionary entry is used across diagrams.
dictId | stringrequired | Dictionary ID |
entryId | stringrequired | Entry ID |
Attributes (9)
crismo_attr_listList all attribute definitions.
crismo_attr_createCreate an attribute definition. Scope: element, process, or dictionary. Value type local or dictionary.
name | stringrequired | Attribute name |
type | stringoptional · default text | |
scope | stringoptional · default element | |
description | stringoptional | |
options | stringoptional | Options for select type |
required | stringoptional | |
valueType | stringoptional · default local | local = inline value; dictionary = references entries |
targetDictionary | stringoptional | Target dictionary ID (required when scope=dictionary) |
sourceDictionary | stringoptional | Source dictionary ID (required when valueType=dictionary) |
selection | stringoptional · default single | Selection mode for dictionary valueType |
crismo_attr_deleteDelete an attribute definition and all its values.
id | stringrequired | Attribute definition ID |
crismo_attr_get_elementGet attribute values for a diagram element.
diagramId | stringrequired | Diagram ID |
elementId | stringrequired | Element ID |
crismo_attr_set_elementSet an attribute value on a diagram element. Provide either `value` (local type) or `dictEntries` (dictionary type).
diagramId | stringrequired | Diagram ID |
elementId | stringrequired | Element ID |
attributeId | stringrequired | Attribute definition ID |
value | numberoptional | Value for local attributes |
dictEntries | stringoptional | Dictionary entry IDs for dictionary-type attributes |
crismo_attr_unset_elementRemove an attribute value from a diagram element.
diagramId | stringrequired | Diagram ID |
elementId | stringrequired | Element ID |
attributeId | stringrequired | Attribute definition ID |
crismo_attr_get_entryGet attribute values for a dictionary entry.
dictId | stringrequired | Dictionary ID |
entryId | stringrequired | Entry ID |
crismo_attr_set_entrySet an attribute value on a dictionary entry. Provide either `value` (local type) or `dictEntries` (dictionary type).
dictId | stringrequired | Dictionary ID |
entryId | stringrequired | Entry ID |
attributeId | stringrequired | Attribute definition ID |
value | numberoptional | |
dictEntries | stringoptional |
crismo_attr_unset_entryRemove an attribute value from a dictionary entry.
dictId | stringrequired | Dictionary ID |
entryId | stringrequired | Entry ID |
attributeId | stringrequired | Attribute definition ID |
Sharing (5)
crismo_share_createCreate a share link for a diagram.
diagramId | stringrequired | Diagram ID |
title | stringoptional | Share title |
snapshot | stringoptional · default false | Snapshot mode (frozen at current state) |
comments | stringoptional · default true | Allow comments |
flags | stringoptional · default true | Allow element flags |
access | stringoptional · default public | Access mode |
anonymousComments | stringoptional · default false | Allow anonymous comments (Teams) |
crismo_share_listList share links for a diagram.
diagramId | stringrequired | Diagram ID |
crismo_share_getGet share link details.
shareId | stringrequired | Share ID |
crismo_share_deactivateDeactivate a share link (keeps it but stops access).
shareId | stringrequired | Share ID |
crismo_share_deleteDelete a share link permanently.
shareId | stringrequired | Share ID |
Milestones (6)
crismo_milestone_listList milestones (checkpoints) for a diagram.
diagramId | stringrequired | Diagram ID |
crismo_milestone_createCreate a checkpoint of the current diagram state.
diagramId | stringrequired | Diagram ID |
label | stringoptional | Milestone label |
description | stringoptional | Description |
crismo_milestone_getGet milestone details (includes BPMN XML).
diagramId | stringrequired | Diagram ID |
milestoneId | stringrequired | Milestone ID |
crismo_milestone_restoreRestore a diagram to a milestone (creates an automatic backup first).
diagramId | stringrequired | Diagram ID |
milestoneId | stringrequired | Milestone ID |
crismo_milestone_compareCompare two milestones of a diagram.
diagramId | stringrequired | Diagram ID |
fromId | stringrequired | From milestone ID |
toId | stringrequired | To milestone ID |
crismo_milestone_deleteDelete a milestone.
diagramId | stringrequired | Diagram ID |
milestoneId | stringrequired | Milestone ID |
Security
- All data stays within your Crismo workspace; tenant isolation keeps it separate from other customers.
- API tokens are never logged. Treat your key like a password and rotate it if exposed.
- Every tool call is subject to standard Crismo permissions.
Looking for the underlying HTTP API? See the REST API reference.
Put your processes to work
The Crismo MCP server turns your process library into precise, traceable answers for your AI agents.