๐Ÿงต Spoolman MCP Server

March 22, 2026 ยท View on GitHub

Version License: MIT TypeScript MCP Spoolman

A Model Context Protocol server for Spoolman โ€” manage your entire 3D printer filament inventory through natural language with Claude and other AI assistants! ๐ŸŽ‰


๐Ÿš€ What is this?

This MCP server bridges the gap between AI assistants (like Claude) and your self-hosted Spoolman instance. Instead of clicking through the Spoolman UI, you can simply ask your AI assistant:

"How much PLA do I have left?" "Add a new Bambu Lab PETG spool, 1kg, red." "Mark spool #12 as used by 50g."

The server exposes the full Spoolman REST API v1 as MCP tools โ€” every vendor, filament, spool, setting, custom field, lookup, and export endpoint is covered.


โœจ Features

  • ๐Ÿญ Vendor Management โ€” Create, read, update, delete vendors
  • ๐ŸŽจ Filament Management โ€” Full CRUD with color, temperature settings, article numbers
  • ๐Ÿงต Spool Management โ€” Track spools, log usage (by weight or length), weight measurement, archiving
  • โš™๏ธ Settings โ€” Read and write Spoolman configuration
  • ๐Ÿท๏ธ Custom Fields โ€” Manage extra fields for vendors, filaments, and spools
  • ๐Ÿ” Lookups โ€” Browse all materials, locations, lot numbers, article numbers
  • ๐Ÿ“ฆ Export โ€” Export data as JSON or CSV
  • ๐Ÿ’“ System โ€” Health check, info, and backup trigger

Note

This server communicates with your local/self-hosted Spoolman instance. You need a running Spoolman before using this MCP server.


๐Ÿ“‹ Requirements

RequirementVersion
Node.jsโ‰ฅ 18
npmโ‰ฅ 9
SpoolmanAny recent version
Claude Desktop / Claude CodeAny

โšก Quick Start

1. Clone & Install

git clone https://github.com/Disane87/spoolman-mcp.git
cd spoolman-mcp
npm install
npm run build

2. Configure Claude Desktop

Add the following to your claude_desktop_config.json:

macOS / Linux: ~/.config/claude/claude_desktop_config.json Windows: %APPDATA%\Claude\claude_desktop_config.json

{
  "mcpServers": {
    "spoolman": {
      "command": "node",
      "args": ["/absolute/path/to/spoolman-mcp/dist/index.js"],
      "env": {
        "SPOOLMAN_URL": "http://localhost:7912"
      }
    }
  }
}

Important

Replace /absolute/path/to/spoolman-mcp with the actual path where you cloned the repository, and http://localhost:7912 with the URL of your Spoolman instance.

3. Restart Claude Desktop & Start Chatting! ๐ŸŽ‰


๐Ÿ”ง Configuration

The server is configured via environment variables:

VariableRequiredDescriptionExample
SPOOLMAN_URLโœ… YesBase URL of your Spoolman instancehttp://localhost:7912
SPOOLMAN_API_KEYโŒ NoBearer token (if behind a proxy with auth)my-secret-key

๐Ÿ› ๏ธ Available MCP Tools

๐Ÿญ Vendors

ToolDescription
spoolman_list_vendorsSearch and list all vendors
spoolman_get_vendorGet a single vendor by ID
spoolman_create_vendorCreate a new vendor
spoolman_update_vendorUpdate an existing vendor
spoolman_delete_vendorDelete a vendor (cascades to filaments!)

๐ŸŽจ Filaments

ToolDescription
spoolman_list_filamentsSearch filaments by name, material, color, vendor...
spoolman_get_filamentGet a single filament by ID
spoolman_create_filamentCreate a new filament definition
spoolman_update_filamentUpdate an existing filament
spoolman_delete_filamentDelete a filament

๐Ÿงต Spools

ToolDescription
spoolman_list_spoolsSearch spools with extensive filters
spoolman_get_spoolGet a single spool by ID
spoolman_create_spoolRegister a new spool
spoolman_update_spoolUpdate spool metadata
spoolman_delete_spoolDelete a spool
spoolman_use_spoolLog filament consumption (g or mm)
spoolman_measure_spoolUpdate remaining weight via scale measurement

โš™๏ธ Settings

ToolDescription
spoolman_get_all_settingsGet all Spoolman settings
spoolman_get_settingGet a specific setting by key
spoolman_set_settingChange a setting value

๐Ÿท๏ธ Custom Fields

ToolDescription
spoolman_list_fieldsList custom fields for an entity type
spoolman_upsert_fieldAdd or update a custom field
spoolman_delete_fieldRemove a custom field

๐Ÿ” Lookups

ToolDescription
spoolman_list_materialsList all known material types
spoolman_list_locationsList all storage locations
spoolman_list_lot_numbersList all lot/batch numbers
spoolman_list_article_numbersList all article numbers
spoolman_rename_locationRename a storage location

๐Ÿ“ฆ Export

ToolDescription
spoolman_export_spoolsExport all spools as JSON or CSV
spoolman_export_filamentsExport all filaments as JSON or CSV
spoolman_export_vendorsExport all vendors as JSON or CSV

๐Ÿ’“ System

ToolDescription
spoolman_get_infoGet Spoolman version and config info
spoolman_health_checkCheck if Spoolman is reachable
spoolman_trigger_backupTrigger a database backup (SQLite only)

๐Ÿ’ฌ Example Conversations

Once connected, you can have natural conversations like:

You: How many spools do I currently have?

Claude: You have 14 spools in Spoolman. 3 of them are archived.
        The active spools include 5x PLA, 4x PETG, and 2x ABS.
You: Add a new Bambu Lab PLA Basic spool. It's red, 1kg, 1.75mm.

Claude: I'll create that for you right away!
        โœ… Spool created: Bambu Lab PLA Basic (Red) โ€” 1000g remaining.
You: I just printed something and used about 45g from spool #7.

Claude: Done! Spool #7 now has 623g remaining (was 668g).
You: I just weighed spool #3 on my kitchen scale โ€” it's 312g total.

Claude: Got it! Based on the empty spool weight of 190g, spool #3
        now shows 122g of filament remaining.

๐Ÿ—๏ธ Project Structure

spoolman-mcp/
โ”œโ”€โ”€ src/
โ”‚   โ”œโ”€โ”€ index.ts          # MCP server entry point & transport
โ”‚   โ”œโ”€โ”€ client.ts         # Typed Spoolman REST API client
โ”‚   โ””โ”€โ”€ tools/
โ”‚       โ”œโ”€โ”€ system.ts     # System tools (health, info, backup)
โ”‚       โ”œโ”€โ”€ vendors.ts    # Vendor CRUD tools
โ”‚       โ”œโ”€โ”€ filaments.ts  # Filament CRUD tools
โ”‚       โ”œโ”€โ”€ spools.ts     # Spool management tools
โ”‚       โ”œโ”€โ”€ settings.ts   # Settings tools
โ”‚       โ”œโ”€โ”€ fields.ts     # Custom field tools
โ”‚       โ”œโ”€โ”€ lookup.ts     # Lookup / discovery tools
โ”‚       โ””โ”€โ”€ export.ts     # Data export tools
โ”œโ”€โ”€ dist/                 # Compiled JavaScript (after npm run build)
โ”œโ”€โ”€ package.json
โ”œโ”€โ”€ tsconfig.json
โ””โ”€โ”€ README.md

๐Ÿ”จ Development

# Install dependencies
npm install

# Build TypeScript
npm run build

# Watch mode (auto-rebuild on changes)
npm run watch

# Run directly with ts-node (no build step)
SPOOLMAN_URL=http://localhost:7912 npm run dev

๐Ÿค Contributing

Contributions are welcome! Feel free to open an issue or pull request if you find a bug, have a feature idea, or want to improve the documentation.

  1. Fork the repository
  2. Create a feature branch (git checkout -b feat/my-feature)
  3. Commit your changes (git commit -m 'feat: add my feature')
  4. Push to the branch (git push origin feat/my-feature)
  5. Open a Pull Request

๐Ÿ“„ License

MIT License โ€” see LICENSE for details.


Check out these other projects from the Spoolman ecosystem:

ProjectDescription
๐Ÿ  Spoolman Home AssistantIntegrate Spoolman with Home Assistant โ€” track spools, get notifications, automate your printing workflow
๐ŸŽจ Spoolman Filament SwatchBeautiful, interactive filament color browser for Spoolman. Live Demo
๐Ÿ“ฆ Spoolman Filament ExtractorExtract your filaments from Spoolman to SpoolmanDB format
๐Ÿ—„๏ธ SpoolmanDBCentralized community filament database used by Spoolman
๐Ÿ–จ๏ธ SpoolmanThe awesome filament manager that powers everything

๐Ÿ™ Credits


Made with โค๏ธ for the 3D printing community