Connect intelligent AI assistants directly to your workspace
The Model Context Protocol gives external AI tools such as Claude Desktop, Cursor, Claude Code, and custom autonomous agents safe, real time access to your Scryme platform. You can query stock counts, inspect sales analytics, examine schedules, stage safe database modifications through tenant isolated endpoints, and execute changes with full audit trails.
Query products, stock batches, orders, customer profiles, and financial aggregates directly without manual data exports.
Every read and write operation is scoped strictly to your organization ID, ensuring complete isolation and zero cross tenant leakage.
AI updates are staged as reviewable drafts with diff summaries, atomic commit confirmations, and safe snapshot rollback.
Transport protocols and connection choices
Scryme supports two primary connection methods defined by the open Model Context Protocol specification:
Best for workstation applications such as Claude Desktop, Cursor, and Claude Code. The client spawns our lightweight command line runner via npx or pnpm, communicating over standard input and output streams.
Best for cloud agents, remote server environments, and web applications. The client connects directly to our modern Streamable HTTP endpoint supporting keep alive streaming, session tracking, and JSON-RPC 2.0 messages over HTTP POST.
Authentication mechanisms and credentials
Before connecting any AI tool, your client must present valid credentials. Scryme provides three flexible authentication pathways:
Generate keys starting with mcp_live_ inside the web portal at /integrations/mcp. The server stores only cryptographic SHA-256 hashes, keeping your credentials secure. Pass via Authorization: Bearer <key>, the x-mcp-api-key header, or the ?key= query parameter.
OAuth clients and user sessions can authenticate using BetterAuth access tokens with scopes mcp:read and mcp:write. The server automatically associates requests with the user active organization.
For custom agent pipelines, you can provide an HS256 signed JSON Web Token holding the organizationId claim along with mcp:read and mcp:write scopes.
OAuth 2.0 discovery and RFC 9728 metadata
The Scryme MCP endpoint implements RFC 9728 OAuth 2.0 Protected Resource Metadata. When an unauthenticated request arrives, the server returns an informative 401 challenge header indicating discovery locations:
curl -i -X GET "https://api.scryme.tech/v3/mcp" # Response: # HTTP/1.1 401 Unauthorized # WWW-Authenticate: Bearer resource_metadata="https://api.scryme.tech/.well-known/oauth-protected-resource/v3/mcp" # Fetching resource metadata: curl -s "https://api.scryme.tech/.well-known/oauth-protected-resource/v3/mcp"
Client setup and configuration files
Here are ready to use snippets for popular AI client platforms. Replace mcp_live_your_workspace_key_here with the token created in your workspace settings.
{
"mcpServers": {
"scryme": {
"command": "npx",
"args": ["-y", "@scryme/mcp-server"],
"env": {
"SCRYME_API_KEY": "mcp_live_your_workspace_key_here",
"SCRYME_API_URL": "https://api.scryme.tech"
}
}
}
}Locate this file on macOS at ~/Library/Application Support/Claude/claude_desktop_config.json or on Windows at %APPDATA%\Claude\claude_desktop_config.json.
{
"mcpServers": {
"scryme": {
"command": "npx",
"args": ["-y", "@scryme/mcp-server"],
"env": {
"SCRYME_API_KEY": "mcp_live_your_workspace_key_here",
"SCRYME_API_URL": "https://api.scryme.tech"
}
}
}
}claude mcp add scryme -- npx -y @scryme/mcp-server
{
"mcpServers": {
"scryme-remote": {
"url": "https://api.scryme.tech/v3/mcp",
"headers": {
"Authorization": "Bearer mcp_live_your_workspace_key_here"
}
}
}
}curl -X POST "https://api.scryme.tech/v3/mcp" \
-H "Authorization: Bearer mcp_live_your_workspace_key_here" \
-H "Content-Type: application/json" \
-H "mcp-session-id: sess_01hxyzexample" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "get_sales_analytics",
"arguments": {
"timeframe": "month"
}
}
}'curl -X POST "https://api.scryme.tech/v3/mcp/tools/execute" \
-H "Authorization: Bearer mcp_live_your_workspace_key_here" \
-H "Content-Type: application/json" \
-d '{
"name": "query_inventory",
"arguments": {
"search": "espresso",
"limit": 5
}
}'The staged draft lifecycle and change safety
Allowing automated models to alter products, create sales records, or reassign shifts requires strong guardrails. Scryme implements a two phase staged mutation pattern:
Note: For trusted automated tasks, tools also accept an optional parameter autoPublish: true to stage and publish changes immediately in one roundtrip.
Standard MCP resources
In addition to callable tools, Scryme exposes standardized MCP resources for context aggregation:
scryme://analytics/summaryapplication/jsonSales and Financial Summary
Live revenue totals, order counts, gross and net values, and key financial performance indicators for the active month.
scryme://inventory/summaryapplication/jsonInventory Overview
Summary of product catalog variant stock quantities, location breakdown, and low stock items.
Complete catalog of MCP tools (23 tools)
External assistants have access to the following workspace tools. Each tool strictly honors your organization boundary and member permissions:
Inventory and Catalog Read Tools
query_inventoryInspect variant stock counts, batch allocations, and quantities across physical locations.
search_productsQuery product catalog records with category filters, barcode matches, and pricing profiles.
Sales, Orders, and Analytics Tools
list_ordersSearch transactions and sales orders filtered by status, customer, or creation date range.
get_order_detailsRetrieve the complete line item breakdown, payments, and fulfillment records for an order.
search_customersLocate customer contact details, profile information, and accumulated loyalty points.
get_sales_analyticsCalculate gross revenue, net revenue, tax aggregates, and average order value for a timeframe.
get_top_selling_productsRank highest performing products based on total sales volume and overall revenue.
Staff and Operations Tools
list_staff_tasksReview team assignments, priority ratings, due dates, and progress states.
get_shift_schedulesRetrieve scheduled employee shifts and active workspace attendance for any date.
Draft Management and Change Staging Tools
list_draftsInspect staged drafts, proposed changes, review statuses, and target entities.
get_draft_diffExamine field level before and after diff comparisons prior to applying mutations live.
publish_draftCommit a staged draft change directly into the database inside an ACID transaction.
revert_draftRoll back an applied draft change cleanly using its recorded before state snapshot.
discard_draftDrop an unapplied draft change safely without affecting any live workspace tables.
Product Catalog Staged Mutations
create_productStage creation of a new catalog product with SKU, category, name, and initial variants.
update_productStage updates to product catalog attributes such as name, description, status, or category.
update_product_priceStage modifications to variant retail price, wholesale price, or buying cost.
Orders and Fulfillment Staged Mutations
create_orderStage a customer transaction with line items, unit pricing, notes, and fulfillment location.
update_order_statusTransition transaction status with full event tracking across the workspace lifecycle.
fulfill_orderStage or record order fulfillment with tracking number, courier service, and dispatch status.
Staff Task Assignment Staged Mutations
create_staff_taskAssign operational responsibilities, priorities, and deadlines to workspace members.
assign_staff_taskStage reassignment of an existing staff task to another workspace staff member.
update_staff_task_statusStage or update task progression (TODO, IN_PROGRESS, COMPLETED, CANCELLED).