Xianmu IMS provides a single AI-agent interface for inventory setup, stock operations, audits, alerts, purchasing, projects, and warehouse data through MCP or REST APIs.
Install & Download
1. ClawHub CLI
The fastest way to install a skill directly from the registry.
npx clawhub@latest install xianmu-ims
2. Manual Installation
Copy the skill folder to one of these locations
~/.openclaw/skills/ <project>/skills/ Priority: Workspace > Local > Bundled
3. Prompt Installation
Copy this prompt to OpenClaw to install it automatically.
Help me install xianmu-ims using Clawhub. If Clawhub is not installed, install it first (npm i -g clawhub).
Prefer to download?
Get the raw skill files in a ZIP archive.
What is Xianmu IMS Inventory Management?
Xianmu IMS is an Openclaw Skills integration for operating a user-deployed Xianmu IMS instance on a local machine, NAS, or private network. It combines inventory search, inbound and outbound stock, transfers, adjustments, stocktakes, low-stock alerts, item records, locations, suppliers, attachments, documents, purchasing, projects, and BOM workflows behind one skill entry point.
The skill also includes a guided initialization experience for creating categories and warehouse locations. It validates connectivity, selects an onboarding scenario, previews the proposed configuration, requests confirmation, and performs administrator-only writes through MCP. This makes Openclaw Skills useful for both first-time setup and safe day-to-day inventory management without sending instance data to external services.
Xianmu IMS Inventory Management Use Cases
- Check item availability, stock levels, warehouse locations, and transaction history.
- Receive existing items or create new item records while recording inbound quantities, suppliers, costs, locations, and remarks.
- Process outbound stock for projects, consumption, or administrator-approved scrap operations.
- Move inventory between warehouse locations and reconcile counted quantities through stock adjustments.
- Create, review, confirm, or cancel stocktake tasks and investigate quantity differences.
- Monitor active inventory alerts and acknowledge resolved low-stock conditions.
- Upload item images, reorder attachments, set cover images, and associate technical documents with multiple items.
- Configure categories and storage locations through the guided initialization workflow.
- Manage purchasing, projects, BOMs, borrowing, suppliers, and administrative master data through available MCP tools.
- Connect automation platforms such as n8n to user-configured Webhooks for inventory, alert, and purchasing events.
How Xianmu IMS Inventory Management Works
- Detect the Xianmu IMS instance by checking the default health endpoint when no base address is provided.
- If the default endpoint is unavailable, ask for the user’s instance URL and test the supplied local, NAS, or remote address before requesting credentials.
- Confirm the
BASEURL and, when available, an API Token beginning withxmt_. Tokens determine viewer, member, or admin permissions and are protected by a 60-request-per-minute limit. - Select the integration path: use the native Streamable HTTP MCP endpoint at
BASE/api/mcpwhen the client supports remote MCP, or use the REST API atBASE/api/v1when MCP is not practical. - Route the request to the appropriate functional workflow, such as item search, inbound stock, outbound stock, transfer, adjustment, stocktake, alert acknowledgement, document management, or onboarding.
- For write operations, restate the item, quantity, destination, or configuration preview and obtain confirmation unless the user’s instruction is already unambiguous.
- Execute batch writes one item at a time, inspect every response, and stop immediately when an operation fails.
- Parse successful business data from the response
datafield and explain API errors using the returned code, message, HTTP status, and details. - Preserve inventory history and avoid destructive endpoints such as item deletion, purge, merge, disable, settings, licensing, token management, and user administration.
- Report the completed operation, resulting identifiers or quantities, and any required follow-up such as acknowledging an alert or reviewing a stocktake difference.
Xianmu IMS Inventory Management Setup
1. Verify connectivity
Use the unauthenticated health endpoint before attempting token-based operations:
curl -s http://127.0.0.1:8066/api/v1/health
A response containing "status": "up" confirms that the instance is online. Record the reported version and edition. If the default address is unavailable, ask for the user’s instance address, for example http://<instance-host>:8066, and test it again.
2. Install Xianmu IMS when needed
If no instance responds, do not repeatedly try tokens. Follow the installation and connection guide in references/setup.md, including the supported Windows installation flow or the user’s selected deployment method. The instance may run locally, on a NAS, or on a remote private network.
3. Create and protect an API Token
In Xianmu IMS, open Settings → API Token, create a token, and provide it to the session only when needed. The token is displayed in plaintext once and typically starts with xmt_. Use the least privilege required:
viewer: read-only operations.member: normal inventory writes.admin: initialization writes, scrap outbound operations, and administrative workflows.
A token is strongly recommended even in single-user mode because it enables rate-limit protection and operation auditing.
4. Configure MCP or REST
For remote MCP-capable clients, configure the Streamable HTTP endpoint:
BASE/api/mcp
Send the token as:
Authorization: Bearer xmt_<token>
The MCP endpoint exposes 67 tools, including 21 read tools and 46 write tools, subject to edition, item-count, role, and read-only restrictions. If MCP is unavailable, use REST with the same authorization header and the API prefix:
BASE/api/v1
The OpenAPI definition is available at BASE/api/openapi.json, with interactive documentation at BASE/api/docs.
5. Initialize the warehouse
For requests such as “initialize,” “create categories,” “create locations,” or “start using the system,” follow references/onboarding.md. The workflow detects the current state, selects a scenario, asks a limited set of questions, previews the proposed categories and locations, obtains confirmation, and writes the configuration through MCP using an admin token.
Xianmu IMS Inventory Management Data Schema & Taxonomy
Connection and response conventions
| Element | Structure or rule |
|---|---|
| REST base path | BASE/api/v1 |
| MCP endpoint | BASE/api/mcp using Streamable HTTP |
| Authentication | Authorization: Bearer <Token> |
| Success envelope | { "code": "OK", "message": "ok", "data": <business data> } |
| Error envelope | { "code": "<error>", "message": "<description>", "details": ... } |
| Pagination | page and page_size; server maximum 200, with 50 or fewer recommended |
| Read-only mode | Append ?mode=readonly to the MCP URL |
| Rate limit | 60 requests per minute |
Inventory entities
- Items: item name, model, type, internal identifiers, unit, category, status, locations, stock quantities, suppliers, images, and linked documents.
- Stock records: inbound, outbound, transfer, adjustment, and stocktake-related transactions with quantities, purposes, locations, timestamps, and remarks.
- Locations and categories: warehouse placement and classification structures created during onboarding or maintained through administrative tools.
- Stocktakes: tasks, stocktake lines, pending filters, counted quantities, differences, confirmation state, and generated adjustment records.
- Alerts: active inventory warnings that can be queried and acknowledged after resolution.
- Documents: uploaded files or fetched links with title, allowed file type, metadata, and many-to-many associations through
items[]. Removing an item only unlinks its documents; deleting a document is a separate irreversible action. - Attachments: item images with a maximum size of 20 MB, ordered so the first attachment can serve as the cover image.
- Business domains: suppliers, purchasing records, projects, BOMs, borrowing workflows, and administrative master data are exposed through the MCP tool layer.
Reference files
references/setup.md: connectivity checks, installation, token creation, verification, and activation guidance.references/api.md: REST endpoints, request bodies, parameters, and response examples.references/onboarding.md: the initialization lifecycle for categories and locations.references/scenarios.md: seven onboarding scenarios and default templates.references/mcp-tools.md: initialization tool names, return structures, and naming rules.
Important error taxonomy
AUTH_REQUIRED indicates a missing or invalid token; FORBIDDEN indicates insufficient role permissions; EDITION_REQUIRED indicates a REST or feature entitlement restriction; LIMIT_EXCEEDED indicates the free-edition 50-item limit; OUT_OF_STOCK indicates insufficient quantity; DUPLICATE_ITEM indicates a possible duplicate; NOT_FOUND indicates a missing entity; RATE_LIMITED indicates more than 60 requests per minute; and READONLY_MODE indicates that writes are disabled.
Xianmu IMS Inventory Management Advanced Features
- Native MCP integration with 67 tools covering inventory reads, writes, stock movements, stocktakes, alerts, purchasing, projects, BOMs, borrowing, documents, and administrative data.
- REST fallback for clients that cannot use remote MCP, with OpenAPI discovery and Swagger UI support.
- Guided, confirmation-based initialization with scenario templates, idempotent writes, and administrator-only configuration changes.
- Optional MCP read-only mode through
?mode=readonlyfor demonstrations and safer inspection environments. - Role-aware execution for viewer, member, and admin tokens, including protected scrap and onboarding operations.
- Multi-location inventory tracking with targeted stock distribution queries and transaction history.
- Stocktake reconciliation that generates adjustment records from confirmed count differences.
- Many-to-many document associations, remote document fetching, local uploads, image ordering, and cover-image management.
- Webhook-compatible event delivery with HMAC signatures for inventory, alert, and purchasing automation platforms such as n8n.
- Structured error handling for authentication, entitlement, limits, conflicts, missing resources, rate limiting, and read-only environments.
- Safety guardrails requiring confirmation before consequential writes, forbidding destructive system endpoints, preventing automatic data deletion, and stopping sequential batch execution after a failure.
- Domain-based documentation architecture that allows new functionality to be added through
references/files while keeping the single Openclaw Skills entry point maintainable.
SKILL.md
Loading
Related Openclaw Skills
FreeCAD CADPilot
FreeCAD CADPilot connects OpenClaw to a local FreeCAD instance through CADPilot’s stdio MCP server and guides safe, advertised-tool-only CAD workflows.
Xiaohongshu Record Organizer
A Node.js-powered Openclaw Skills integration that retrieves and organizes public Xiaohongshu notes, creator posts, comments, and engagement metrics for research and decision-making.
Infinite Creation
Infinite Creation orchestrates a local AI workflow that transforms novels, scripts, or ideas into voiced comic dramas and short videos.
List Your Series
Help independent creators get their manga, webcomic, webtoon, light novel or anime discovered by listing or claiming it in AnimeHunt’s free directory.
call4me
call4me lets your AI agent call businesses to handle bookings, changes, cancellations, questions, and hold times, then report back with the outcome.
Professional Engine Suite
A five-engine reasoning suite that routes high-stakes questions through auditable workflows, verifies results, labels confidence, and refuses unsupported conclusions.
Featured*
