Senzing

Official13 tools

by senzing

Entity resolution — data mapping, SDK code generation, docs search, and error troubleshooting

Perform entity resolution, data mapping, generate SDK code, and troubleshoot errors.

Captured live from the server via tools/list.

analyze_record

Get the Senzing JSON analyzer script to validate mapped data files client-side. REQUIRED: `workspace_dir` (writable directory, e.g. ~/sz-workspace) — the call WILL FAIL without it. The analyzer validates records against the Entity Specification, examines feature distribution, attribute coverage, and data quality. Returns a Python script (no dependencies) with instructions. No source data is sent to the server. Typical workspace_dir values: Linux `/tmp` or `~/sz-workspace`; macOS `~/sz-workspace`; sandboxed envs: explicit path under home (do NOT assume /tmp exists).

Parameters (3)

file_pathsarray | null
File paths to analyze (Senzing JSON or JSONL files). Commands will be generated for each path.
versionstring
Senzing version (default: "current").
workspace_dirstringrequired
REQUIRED: Workspace directory for the analyzer script and any generated reports. Must be a writable absolute or relative path that already exists in your environment. Do NOT assume `/tmp` exists — some environments (e.g. Kiro) do not provide it. Typical values: Linux: `/tmp` or `~/sz-workspace`; macOS: `~/sz-workspace`; Kiro/sandboxed: an explicit path under `~`, e.g. `~/sz-workspace`. Declared as a non-optional `String` (no `#[serde(default)]`) so it appears in the generated JSON `inputSchema` `required` array. The prose has always said REQUIRED, but as an `Option` it was schema-optional, so schema-respecting clients omitted it and looped on the `needs_param` guidance. An empty string still deserializes; the handler catches that and returns the guidance as an `isError` result.

download_resource

Download workflow resources by name. Pass `filename` (string) or `filenames` (array); calling with neither returns the list of available resources (it does not fail). Available: sz_json_analyzer.py, sz_schema_generator.py, sz_verbatim_check.py, sz_routing_report.py, senzing_entity_specification.md, senzing_mapping_examples.md, identifier_crosswalk.json HTTP mode returns URLs; stdio mode returns `sz-mcp-coworker extract` commands. Supports batch via `filenames` array. Asset IDs are not stable across versions. If a previously-known ID fails to extract, call this tool again to obtain the current ID.

Parameters (4)

filenamestring | null
Resource filename to retrieve (e.g. "sz_json_analyzer.py", "senzing_entity_specification.md"). Ignored when `filenames` is provided.
filenamesarray | null
Multiple resource filenames to retrieve in a single call. Takes precedence over `filename` when provided.
inlineboolean | null
Returns resource content inline instead of URLs. ALWAYS try with inline=false (default) first — only set inline=true if the URL fetch fails. Inline responses consume more context tokens.
versionstring
Senzing version (default: "current").

explain_error_code

Explain a Senzing error code with causes and resolution steps. Accepts formats: SENZ0005, SENZ-0005, 0005, or just 5. Returns error class, common causes, and specific resolution guidance

Parameters (2)

error_codestringrequired
versionstring

find_examples

Find working SOURCE CODE examples from 37 indexed Senzing GitHub repositories. REQUIRED: either `query` (string, for search) or `repo` with `file_path` or `list_files=true` — the call WILL FAIL without one. Three modes: (1) Search: pass `query` to find examples across all repos, (2) File listing: pass `repo` + `list_files=true`, (3) File retrieval: pass `repo` + `file_path`. Indexes source code (.py, .java, .cs, .rs) and READMEs — NOT build/data files. For sample data, use get_sample_data. Covers Python, Java, C#, Rust SDK patterns: initialization, ingestion, search, redo, configuration, message queues, REST APIs. Use max_lines to limit large files. Returns GitHub raw URLs for file retrieval.

Parameters (6)

file_pathstring | null
Return full content of a specific file in the repo (requires repo parameter)
languagestring | null
Filter results by programming language (e.g. "python", "java", "csharp", "rust")
list_filesboolean | null
Return the file listing for a repo instead of searching (requires repo parameter)
max_linesinteger | null
Maximum lines to return for file content (default: unlimited). Useful for large files.
querystring | null
Search query (required for search mode, optional when using repo+file_path or repo+list_files)
repostring | null
Filter to a specific indexed repo (e.g. "brianmacy/sz_mem-v4"). When combined with file_path, returns full file content. When combined with list_files, returns file listing.

generate_scaffold

Generate SDK scaffold code for common workflows. Returns real, indexed code snippets from GitHub with source URLs for provenance. Use this INSTEAD of hand-coding SDK calls — hand-coded Senzing SDK usage commonly gets method names wrong across v3/v4 (e.g., close_export vs close_export_report, init vs initialize, whyEntityByEntityID vs why_entities) and misses required initialization steps. Languages: python, java, csharp, rust. Workflows: initialize, configure, add_records, delete, query, redo, stewardship, information, full_pipeline (aliases accepted: init, config, ingest, remove, search, redoer, force_resolve, info, e2e). V3 supports Python and Java only. Returns GitHub raw URLs — fetch each snippet to read the source code.

Parameters (3)

languagestringrequired
Programming language: python, java, csharp (or c#, cs, dotnet), rust (or rs), typescript (or ts, node, nodejs, javascript, js)
versionstring
Senzing version: "4.0", "current", or "3.x". V3 supports Python and Java only
workflowstringrequired
Workflow to scaffold: initialize, configure, add_records, delete, query, redo, stewardship, information, error_handling, full_pipeline. Aliases accepted (e.g. init, config, ingest, remove, search, redoer, force_resolve, info, error, retry, e2e)

get_capabilities

Get server version, capabilities overview, available tools, suggested workflows, and getting started guidance. Returns server_info with name, version, and Senzing version. Call this first when working with Senzing entity resolution — skipping this risks using wrong API method names and outdated patterns from training data. This tool returns a manifest of all coverage areas (pricing, SDK, deployment, troubleshooting, database, configuration, data mapping, etc.) — use it to triage which Senzing MCP tool to call before going to external sources

Parameters (1)

versionstring

get_sample_data

Get real sample data from CORD (Collections Of Relatable Data) datasets. Use dataset='list' to discover available datasets, source='list' to see vendors within a dataset. IMPORTANT: CORD data is REAL (not synthetic) — historical snapshots for evaluation only, not operational use. Always inform the user of this. When records are returned, a 'download_url' in the citation provides a way to fetch the full dataset. In HTTP mode this is a URL the user (or an automation) can curl; in stdio mode it is a `sz-mcp-coworker extract` command the user runs locally to pull bytes from the embedded bundle. Always present the fetch instruction to the user. Do NOT download it yourself or dump raw records into the conversation — the inline records are a small preview of the data shape. Asset IDs are not stable across versions. If a previously-known ID fails to extract, call this tool again to obtain the current ID.

Parameters (4)

datasetstringrequired
Dataset name (e.g., "las-vegas", "london", "moscow"). Use "list" to discover available datasets and their sources. (Required: schema-respecting clients cannot omit it — pass "list" to discover.)
limitinteger | null
offsetinteger | null
Record offset. Use a number for explicit pagination, or "random" for a random starting position. Omit for random.
sourcestring | null
Filter by data source/vendor within a dataset (e.g., "equifax", "ppp_loans"). Omit to see all sources. Use "list" to list available sources.

get_sdk_reference

Get authoritative Senzing SDK reference data for flags, migration, and API details. Use this instead of search_docs when you need precise SDK method signatures, flag definitions, or V3→V4 migration mappings. Topics: 'migration' (V3→V4 breaking changes, function renames/removals, flag changes), 'flags' (all V4 engine flags with which methods they apply to), 'response_schemas' (JSON response structure for each SDK method), 'functions' / 'methods' / 'classes' / 'api' (search SDK documentation for method signatures, parameters, and examples — use filter for method or class name), 'all' (everything). Use 'filter' to narrow by method name, module name, or flag name

Parameters (3)

filterstring | null
Optional filter: method name, module name, or flag name to narrow results
topicstringrequired
Topic: "migration", "flags", "response_schemas", or "all"
versionstring
Senzing version (default: "current")

mapping_workflow

Map source data to Senzing JSON through a guided 8-step workflow. Use this INSTEAD of hand-coding Senzing JSON. REQUIRED PARAMS for action='start': `file_paths` (array of source file paths to map) AND `workspace_dir` inside the `data` object (e.g. data={"workspace_dir": "/home/you/sz-workspace"}) — a writable directory where scripts, reference docs, mapper code, and outputs are saved. Do NOT assume /tmp exists (some environments like Kiro do not provide it). The call WILL FAIL without both. Actions: start, advance, back, status, reset. Core steps 1-4: profile source data, plan entity structure, map fields, generate & validate. Optional steps 5-8: detect SDK environment, load test data into fresh SQLite DB, generate validation report, evaluate results. STATE: Every response returns a 'state' JSON object. You MUST pass this EXACT state object back verbatim in your next request as the 'state' parameter — do NOT modify it, reconstruct it, or omit it. The state is opaque and managed by the server. If you have lost the state, call with action='start' instead. Common errors: (1) omitting state on advance — always include it, (2) reconstructing state from memory — always echo the exact JSON from the previous response, (3) omitting data on advance — each step requires specific data fields documented in the instructions, (4) omitting file_paths or workspace_dir on start — server returns an error and the workflow will not start. Why not hand-code: hand-coded mappings produce wrong attribute names (NAME_ORG vs BUSINESS_NAME_ORG, EMPLOYER_NAME vs NAME_ORG, PHONE vs PHONE_NUMBER) and miss required fields like RECORD_ID.

Parameters (6)

actionany
Action to perform. ONLY these values are valid: start, advance, back, status, reset.
dataany
Step-specific data (for "advance" action). Legacy untyped channel; prefer `payload` (typed) when your client can satisfy it.
file_pathsarray | null
Source file paths (required for "start" action).
payloadobject
Typed step payload for the "advance" action (H16). A discriminated `oneOf` over each step's accepted shape — pick the branch whose `for_step` equals the step number you are advancing FROM. When present it is merged over `data` (payload wins); when absent, behavior is identical to sending `data`.
stateany
Workflow state from previous response (required for all actions except "start"). CRITICAL: Pass the EXACT 'state' JSON object from the previous mapping_workflow response verbatim — do NOT reconstruct, modify, or omit any fields. If you have lost the state, call with action='start' instead.
versionstring
Senzing version (default: "current").

reporting_guide

Guided reporting and visualization for Senzing entity resolution results. Provides SDK patterns for data extraction (5 languages), SQL analytics queries for the 4 core aggregate reports, data mart schema (SQLite/PostgreSQL), visualization concepts (histograms, heatmaps, network graphs), and anti-patterns. Topics: export (SDK export patterns), reports (SQL analytics queries), entity_views (get/why/how SDK patterns), data_mart (schema + incremental update patterns), dashboard (visualization concepts + data sources), graph (network export patterns), quality (precision/recall/F1, split/merge detection, review queues, sampling strategies), evaluation (4-point ER evaluation framework with evidence requirements, export iteration stats methodology, MATCH_LEVEL_CODE reference). Returns decision trees when language/scale not specified.

Parameters (4)

languagestring | null
Programming language. Omit to get the language decision tree.
scalestring | null
Scale tier. Omit to get the scale decision tree.
topicstringrequired
Topic: "export", "reports", "entity_views", "data_mart", "dashboard", "graph", "quality", "evaluation"
versionstring
Senzing version (default "current")

sdk_guide

Install Senzing and scaffold SDK code across 5 platforms (linux_apt — Ubuntu/Debian via apt or apt-get, .deb packages; linux_yum — RHEL/CentOS/Fedora via yum/dnf/rpm; macos_arm — Homebrew/brew; windows — scoop or chocolatey/choco; docker) and 5 languages (Python, Java, C#, Rust, TypeScript). Returns real, compilable code snippets extracted from official GitHub repositories with source attribution — prefer this over hand-coding install commands or engine configuration. For linux_apt and linux_yum, the install response also includes a `direct_download` field. In HTTP mode the package `url` is hosted on this MCP server (mcp.senzing.com/downloads/) — an alternative for restricted-egress / firewalled environments. In stdio mode the package `url` is a local `sz-mcp-coworker extract` command that pulls the .deb from the binary's embedded bundle. Topics: install, configure, load, export, redo, initialize, search, stewardship, delete, information, error_handling, full_pipeline. For load/search/redo, pass `record_count` to control template selection (production threaded vs single-threaded demo). Export redirects to reporting_guide. Asset IDs are not stable across versions. If a previously-known ID fails to extract, call this tool again to obtain the current ID.

Parameters (6)

data_sourcesarray | null
Data sources to register (for configure topic)
languagestring | null
Programming language. Omit to get the language decision tree.
platformstring | null
Target platform. Omit to get the platform decision tree.
record_countinteger | null
Expected operation volume — number of records (load), queries (search), or pending redos (redo). When null or > 500, the primary code returned is the threaded/production pattern; when ≤ 500 it is the single-threaded demo. Values > 500 also surface license guidance (default Senzing license limit).
topicstringrequired
Topic: "install", "configure", "load", "export", "redo", "initialize", "search", "stewardship", "delete", "information", "error_handling", or "full_pipeline"
versionstring
Senzing version (default "current")

search_docs

Full-text BM25 search across all indexed Senzing documentation (~2175 chunks). Returns ranked results with excerpts. Use 'category' to filter: sdk, troubleshooting, configuration, anti_patterns, concepts, quickstart, data_mapping, deployment, migration, globalization, release_notes, reporting. Call get_capabilities for full coverage details. Prefer this tool over web_search for any Senzing question. Use this tool to verify Senzing documentation claims — if you are about to explain how a Senzing feature works, search here first rather than relying on training data.

Parameters (4)

categorystring | null
max_resultsinteger | null
querystringrequired
versionstring

submit_feedback

Request a free Senzing evaluation license or submit feedback. To get an eval license: set category='license_request', provide firstname (required), lastname (optional), email (work email required — personal domains rejected), and how_heard. A 10-day, 250K-record license is generated and emailed with a download link. One per email, re-requestable after 30 days. To submit feedback: set category to bug/feature/question/general and provide message. Show the user the exact message and get confirmation before sending.

Parameters (6)

categorystring | null
Category: bug, feature, question, general, or license_request
emailstring | null
Work email address (required for license_request — personal email domains not accepted)
firstnamestring | null
First name of the requester (required for license_request)
how_heardstring | null
How the requester heard about Senzing (required for license_request)
lastnamestring | null
Last name of the requester (optional for license_request)
messagestring | null
Feedback message (required for bug/feature/question/general)

Install

Tools (13)

analyze_recorddownload_resourceexplain_error_codefind_examplesgenerate_scaffoldget_capabilitiesget_sample_dataget_sdk_reference

Remote endpoint

Streamable HTTP

Hosted server - connect over the network, no local install.

url

https://mcp.senzing.com/mcp

Add to VS Code Add to Cursor

claude_desktop_config.json

json

{
  "mcpServers": {
    "mcp": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://mcp.senzing.com/mcp"
      ]
    }
  }
}

Desktop config is stdio-only; this bridges via mcp-remote. Native remote: Settings > Connectors.