Developers
MCP server
The Reckn MCP server exposes your workspace to any client that speaks the Model Context Protocol. Upload folders of documents, generate and lock criteria, start runs and pull reports — described in plain language instead of assembled by hand.
What it is
A local process that exposes the Reckn API to your MCP client as tools. The client decides which calls to make; the server executes them against your workspace using your API key. Nothing new is exposed — it is the same API, driven conversationally.
It is most useful for the bulk and ad-hoc work that is tedious through a UI and not worth writing a script for: pushing a folder of fifty proposals through, pulling a batch of reports to disk, checking what failed last night.
Requirements
- Node.js 18 or later
- An MCP client
-
A Reckn workspace API key. Create one in the app under Settings → API
keys; it starts with
rk_.
Install
Install the server's dependencies where the server lives.
npm install
Register the server
Add the server to your MCP client's configuration. Clients differ in where that file lives and what it is called — check your client's documentation for the path. The entry itself has the same shape everywhere: a command, its arguments, and the environment it runs with.
{
"mcpServers": {
"reckn": {
"command": "node",
"args": ["/absolute/path/to/reckn-mcp-server.js"],
"env": {
"RECKN_API_BASE": "https://dashboard.reckn.app/api",
"RECKN_API_KEY": "rk_your_api_key"
}
}
}
}
| Variable | Value |
|---|---|
RECKN_API_BASE |
The API base URL. Both variables are required — the server exits immediately without them. |
RECKN_API_KEY |
Your rk_ workspace key. Every call is scoped to it,
and every call is attributed to it in the activity log.
|
The config holds a live workspace credential in clear text on your machine. Use a key issued for this purpose so it can be revoked on its own, and revoke it if the machine changes hands.
Restart your client. The server starts automatically.
Reckn tools available in an MCP client after restart.
Verify
Ask for something read-only first:
List my Reckn pipelines.
If your pipelines come back, the key, the base URL and the registration are all correct.
Using it
Describe the outcome. The client works out the calls.
Upload the folder at /docs/job-descriptions as source documents
for pipeline abc-123
Generate criteria for criteria set def-456 from those documents,
then lock it
Run pipeline abc-123 with criteria def-456 against document ghi-789
Get the report for run jkl-012 as a PDF and save it to /tmp/report.pdf
A folder of documents uploaded, criteria generated and locked, a run started, and the report saved — all from the client.
The server can delete pipelines, criteria sets, documents and runs. Say what you want deleted explicitly and by ID. "Clean up the old ones" is an instruction the client will interpret, and deletes are recorded but not undone from here.
Tools
Pipelines
| Tool | What it does |
|---|---|
list_pipelines | Lists the workspace's pipelines |
get_pipeline | One pipeline with its criteria, resources, templates and prompts |
get_pipeline_templates | Report templates for a pipeline |
delete_pipeline | Removes a pipeline from the workspace |
Catalog
| Tool | What it does |
|---|---|
get_catalog | Pipeline templates available to add |
add_catalog_pipeline | Adds a pipeline to the workspace from a template |
Criteria
| Tool | What it does |
|---|---|
list_criteria | Criteria sets for a pipeline; filters on search and status |
get_criteria | One criteria set in full |
create_criteria | Creates a criteria set |
update_criteria | Updates name, description, criteria items, comparisons or weighting fields |
delete_criteria | Deletes a criteria set |
generate_criteria | Generates criteria from source documents |
generate_criterion | Generates a single additional criterion |
lock_criteria | Locks a set against edits |
unlock_criteria | Reopens a locked set |
set_default_criteria | Marks a set as the pipeline default |
Weighting
| Tool | What it does |
|---|---|
get_criteria_comparisons | The pairwise comparison matrix |
update_comparison | Records one pairwise comparison |
generate_simple_weights | Derives weights, fast path |
generate_advanced_weights | Derives weights with finer-grained reasoning |
Documents
| Tool | What it does |
|---|---|
list_documents | All documents; filters on pipeline, type and time window |
get_document | One document's metadata |
download_document | Writes a document's file to a local path |
delete_document | Deletes a document |
list_pipeline_documents | Documents scoped to one pipeline |
get_pipeline_document | One document within a pipeline |
delete_pipeline_document | Removes a document from a pipeline |
upload_source_file | Uploads one local file as a source document |
upload_target_file | Uploads one local file as a target document |
upload_source_documents | Uploads every supported file in a folder as sources, in batches of 10 |
upload_target_documents | Uploads every supported file in a folder as targets, in batches of 10 |
Runs
| Tool | What it does |
|---|---|
list_runs | Runs; filters on status, pipeline, run id, search and time window |
get_run | One run with criteria, evaluation, decision and summary output |
get_run_report | The run's report as HTML or PDF, optionally saved to disk |
get_run_data | Raw execution results |
get_run_artifacts | The run's artifact — latest, a specific version, or all versions |
create_run | Creates and starts a run |
retrigger_run | Re-runs a failed or completed run |
update_run | Renames a run |
delete_run | Deletes a run |
Logs
| Tool | What it does |
|---|---|
list_activity_logs | Audit trail entries |
list_usage_logs | Usage with token counts and model info |
Supported files
.pdf, .docx, .doc,
.txt, .rtf, .xlsx,
.csv.
A folder upload silently skips anything else — it does not fail. If a file you expected is missing afterwards, check its extension first.
Troubleshooting
| Symptom | Usual cause |
|---|---|
| No Reckn tools in the client |
The client was not restarted, the path in args is
not absolute, or dependencies were never installed.
|
| The server exits on start |
RECKN_API_BASE or RECKN_API_KEY is
missing. Both are required.
|
| Every call fails on authorization |
The key is not an rk_ workspace key, or it has been
revoked.
|
| A resource "does not exist" but you can see it in the app | The key belongs to a different workspace. |
| Files in a folder were not uploaded | Unsupported extensions are skipped. Per-file errors come back in the result — ask the client what it reported. |
Login
Request a demo