bizSupply MCP Server

Connect bizSupply to AI assistants like Claude Desktop using the Model Context Protocol (MCP) server.

Last updated: 2026-04-01

What is MCP?

The Model Context Protocol (MCP) is an open standard that allows AI assistants to interact with external tools and data sources. The bizSupply MCP Server exposes your bizSupply workspace as a set of tools that AI assistants like Claude Desktop can use directly in conversation.

With the MCP server running, you can ask your AI assistant to list documents, create pipelines, execute jobs, and retrieve extraction results — all through natural language. The assistant calls the bizSupply API on your behalf using the MCP tool interface.

Installation

The bizSupply MCP server is distributed as an npm package. Install it globally:

bash

npm install -g @bizsupply/mcp-server

Or run it directly with npx (no installation required):

bash

npx @bizsupply/mcp-server@latest

Verify the installation:

bash

npx @bizsupply/mcp-server --version
="color:#5c6370;font-style:italic"># Output: @bizsupply/mcp-server 1.2.0

Configuration

To use the MCP server with Claude Desktop (or any MCP-compatible client), add it to your MCP configuration file.

Claude Desktop

Add the following to your Claude Desktop MCP configuration (typically located at ~/Library/Application Support/Claude/claude_desktop_config.json on macOS or %APPDATA%/Claude/claude_desktop_config.json on Windows):

claude_desktop_config.jsonjson

{
  "mcpServers": {
    "bizsupply": {
      "command": "npx",
      "args": ["@bizsupply/mcp-server@latest"],
      "env": {
        "BIZSUPPLY_API_KEY": "your-api-key-here",
        "BIZSUPPLY_API_URL": "https://api.bizsupply.com"
      }
    }
  }
}

⚠️Warning

Replace "your-api-key-here" with your actual bizSupply API key. You can generate an API key from your bizSupply dashboard at app.bizsupply.ai/settings/api-keys.

Environment Variables

Variable	Required	Default	Description
BIZSUPPLY_API_KEY	Yes	—	Your bizSupply API key for authentication.
BIZSUPPLY_API_URL	No	https://api.bizsupply.com	API base URL. Override for self-hosted or staging environments.
BIZSUPPLY_TIMEOUT	No	30000	Request timeout in milliseconds.
BIZSUPPLY_LOG_LEVEL	No	info	Logging level: debug, info, warn, error.

Available Tools

The MCP server exposes the following tools that AI assistants can invoke. Each tool maps to one or more bizSupply API endpoints.

Document Tools

Tool	Description	API Endpoint
list_documents	List documents with optional filters (status, type, date range).	GET /v1/documents
get_document	Get a single document by ID, including extracted fields.	GET /v1/documents/:id
upload_document	Upload a document for processing (base64-encoded content).	POST /v1/documents
search_documents	Full-text search across document content and extracted fields.	GET /v1/documents/search
delete_document	Delete a document and its extracted data.	DELETE /v1/documents/:id

Pipeline Tools

Tool	Description	API Endpoint
list_pipelines	List all pipelines with status and configuration.	GET /v1/pipelines
create_pipeline	Create a new pipeline from a plugin/ontology configuration.	POST /v1/pipelines
execute_pipeline	Trigger a pipeline execution, creating a new job.	POST /v1/pipelines/:id/execute
get_pipeline	Get pipeline details including plugin references.	GET /v1/pipelines/:id

Job Tools

Tool	Description	API Endpoint
list_jobs	List recent jobs with status and progress.	GET /v1/jobs
get_job	Get detailed job status, including per-document progress.	GET /v1/jobs/:id
get_job_documents	List documents processed by a specific job with extracted data.	GET /v1/jobs/:id/documents
cancel_job	Cancel a running or queued job.	POST /v1/jobs/:id/cancel

Resource Tools

Tool	Description	API Endpoint
list_plugins	List registered plugins by type.	GET /v1/plugins
list_ontologies	List ontologies with field counts.	GET /v1/ontologies
list_credentials	List stored credentials (names and types only, no secrets).	GET /v1/credentials

Usage Examples

Once configured, you can interact with bizSupply through natural language in your AI assistant. Here are some example conversations:

Listing Documents

You: "Show me all invoices processed this week."

The assistant calls list_documents with filters for document_type: "invoice" and a date range covering the current week, then presents the results in a formatted table.

Running a Pipeline

You: "Run the invoice processing pipeline with a limit of 10 documents."

The assistant calls list_pipelines to find the invoice pipeline, then calls execute_pipeline with max_documents: 10. It reports the job ID and monitors progress by polling get_job.

Inspecting Extraction Results

You: "Show me what was extracted from document doc_inv_042."

The assistant calls get_document with the ID and presents the extracted fields in a readable format, highlighting any missing required fields.

Creating a Pipeline

You: "Create a pipeline that processes purchase orders from the accounting email inbox using the PO ontology."

The assistant calls list_plugins, list_ontologies, and list_credentials to identify the available components. It then calls create_pipeline with the appropriate references and confirms the created pipeline with you.

Checking Job Status

You: "What is the status of my last job?"

The assistant calls list_jobs with a limit of 1, sorted by most recent. It presents the job status, progress counts, and any errors encountered.

Troubleshooting

Issue	Resolution
MCP server not appearing in Claude Desktop	Verify the config file path and JSON syntax. Restart Claude Desktop after saving changes.
Authentication errors	Check that BIZSUPPLY_API_KEY is set correctly. Generate a new key if the current one may be expired.
Timeout errors on large operations	Increase BIZSUPPLY_TIMEOUT to 60000 or higher for pipelines processing many documents.
Tools not responding	Run the MCP server manually (npx @bizsupply/mcp-server) to check for startup errors in the console output.
"Tool not found" errors	Ensure you are using the latest version of the MCP server: npx @bizsupply/mcp-server@latest.

Security Considerations

The MCP server runs locally on your machine and communicates directly with the bizSupply API using your API key. Keep the following in mind:

Your API key is stored in the MCP configuration file. Ensure this file has appropriate file-system permissions.
The MCP server does not store or cache any data. All requests are forwarded directly to the bizSupply API.
All API communication uses HTTPS. The server does not support insecure HTTP connections.
The MCP server inherits the permissions of your API key. Use a key with the minimum required scopes for your workflow.
Credential secrets are never returned through MCP tools — only credential names and types are visible.

REFERENCEPlugin Service API ACCOUNTYour Subscription