MCP Server
Connect AI agents to your data via Model Context Protocol
MCP Server
01.software provides an MCP (Model Context Protocol) server that lets AI agents interact with your collections directly. Query, create, update, and delete data through natural language in tools like Claude, Cursor, VS Code, and more.
Setup
Get API Keys
In the 01.software Console, go to your tenant settings to find your API keys. You can also generate the Base64-encoded API key directly from the Console.
- Client Key — Public key (read-only)
- Secret Key — Private key (read/write)
- API Key — Base64-encoded key for MCP authentication (
clientKey:secretKey)
You can also generate the API key programmatically if needed:
import { createApiKey } from '@01.software/sdk'
const apiKey = createApiKey(clientKey, secretKey)echo -n "your-client-key:your-secret-key" | base64Configure Your Client
Add the MCP server to your AI tool of choice.
Add via CLI command:
claude mcp add --transport http \
--header "x-api-key: <your-api-key>" \
01software https://mcp.01.software/mcpOr create .mcp.json at your project root:
{
"mcpServers": {
"01software": {
"type": "http",
"url": "https://mcp.01.software/mcp",
"headers": {
"x-api-key": "<your-api-key>"
}
}
}
}Add to .cursor/mcp.json (project root or ~/.cursor/mcp.json):
{
"mcpServers": {
"01software": {
"url": "https://mcp.01.software/mcp",
"headers": {
"x-api-key": "<your-api-key>"
}
}
}
}Add to ~/.codeium/windsurf/mcp_config.json:
{
"mcpServers": {
"01software": {
"serverUrl": "https://mcp.01.software/mcp",
"headers": {
"x-api-key": "<your-api-key>"
}
}
}
}Windsurf uses serverUrl instead of url.
Add to .vscode/mcp.json:
{
"inputs": [
{
"type": "promptString",
"id": "01software-api-key",
"description": "01.software API Key",
"password": true
}
],
"servers": {
"01software": {
"type": "http",
"url": "https://mcp.01.software/mcp",
"headers": {
"x-api-key": "${input:01software-api-key}"
}
}
}
}VS Code uses servers instead of mcpServers. The inputs array lets you securely prompt for the API key.
Add to claude_desktop_config.json:
{
"mcpServers": {
"01software": {
"url": "https://mcp.01.software/mcp",
"headers": {
"x-api-key": "<your-api-key>"
}
}
}
}macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Windows: %APPDATA%\Claude\claude_desktop_config.json
Available Tools
The MCP server provides 20 tools for collection CRUD and ecommerce operations.
Generic CRUD (7)
| Tool | Description |
|---|---|
query-collection | Query a collection with filtering, sorting, and pagination |
get-collection-by-id | Get a single item by ID |
create-collection | Create a new item |
update-collection | Update an existing item |
delete-collection | Delete an item |
update-many-collection | Bulk update items matching a filter |
delete-many-collection | Bulk delete items matching a filter |
Order & Fulfillment (6)
| Tool | Description |
|---|---|
create-order | Create order with products and shipping |
update-order | Update order status (auto stock adjustment) |
get-order | Get order by order number |
checkout | Convert cart to order (stock validation) |
create-fulfillment | Create shipment for order items |
update-transaction | Update transaction status |
Returns (3)
| Tool | Description |
|---|---|
create-return | Create return request (delivered/confirmed orders) |
update-return | Update return status (FSM validated) |
return-with-refund | Combined return + refund operation |
Cart (3)
| Tool | Description |
|---|---|
add-cart-item | Add product to cart (stock validated) |
update-cart-item | Update cart item quantity |
remove-cart-item | Remove item from cart |
Product (1)
| Tool | Description |
|---|---|
stock-check | Batch check product option stock availability |
Write operations require a Secret Key. If you only provided a Client Key, only read operations will be available.
Usage Examples
Once configured, you can interact with your data using natural language:
- "Show me the latest 10 published products"
- "Create a new post with title 'Hello World'"
- "Update all draft posts to published status"
- "How many orders were created this month?"
- "Delete the product with ID abc123"
Prompts
The MCP server includes built-in prompts to help AI assistants understand your data:
| Prompt | Description |
|---|---|
sdk-usage-guide | SDK usage patterns and best practices |
collection-query-help | Query writing assistance for specific collections |
review-code | Code review for SDK integration code |
Resources
The MCP server exposes documentation and schema information as resources:
| Resource | URI | Description |
|---|---|---|
| API Reference | docs://api | REST and GraphQL API documentation |
| Getting Started | docs://getting-started | Onboarding guide |
| Guides | docs://guides | Usage guides |
| Collection Schema | collections://schema | Collection field definitions |
| App Config | config://app | Application configuration |
Supported Collections
All SDK-accessible collections are available through MCP:
- Tenant — tenants, tenant-metadata, tenant-logos, tenant-og-images
- Products — products, product-variants, product-options, product-categories, product-tags, product-images, brands, brand-logos
- Orders — orders, order-products, returns, return-products, exchanges, exchange-products, fulfillments, fulfillment-items, transactions
- Customers — customers, customer-addresses
- Carts — carts, cart-items, discounts, shipping-policies
- Documents — documents, document-categories, document-images
- Posts — posts, post-categories, post-tags, post-images
- Media — playlists, playlist-images, musics, media
- Forms — forms, form-submissions
Security
- Store your API key securely. Do not share it or commit it to version control.
- Use environment variables in production environments.
- The API key grants the same access level as the underlying Client Key + Secret Key pair.
Next Steps
- llms.txt — Export documentation for LLM consumption
- Authentication — API key details
- Collections — Available collections and their fields