# Mcp Klipper Docs

> MCP server for Klipper 3D printer firmware documentation

- **Type:** MCP server
- **Install:** `agentstack add mcp-bpuhnk-mcp-klipper-docs`
- **Verified:** Yes — security-reviewed for prompt injection and unsafe behavior
- **Seller:** [bpuhnk](https://agentstack.voostack.com/s/bpuhnk)
- **Installs:** 0
- **Category:** [Integrations](https://agentstack.voostack.com/c/integrations)
- **Latest version:** 0.1.0
- **License:** MIT
- **Upstream author:** [bpuhnk](https://github.com/bpuhnk)
- **Source:** https://github.com/bpuhnk/mcp-klipper-docs

## Install

```sh
agentstack add mcp-bpuhnk-mcp-klipper-docs
```

Requires the [AgentStack CLI](https://agentstack.voostack.com/docs/cli). Works with Claude Code, Cursor, and any MCP-compatible agent.

## About

# 🖨️ MCP Klipper Documentation Server

[](https://badge.fury.io/js/mcp-klipper-docs)
[](https://opensource.org/licenses/MIT)
[](https://www.typescriptlang.org/)
[](https://nodejs.org/)
[](https://modelcontextprotocol.io/)

**AI-Powered Klipper Documentation at Your Fingertips**

A Model Context Protocol (MCP) server that transforms how you interact with Klipper 3D printer firmware documentation.

[🚀 Quick Start](#-quick-start) • [📖 Documentation](#-documentation) • [🔧 Configuration](#-configuration) • [🤝 Contributing](#-contributing)

---

## 🖼️ See It In Action

*Experience seamless Klipper documentation access directly within Claude Desktop. Search configurations, browse documentation, and get instant answers to your 3D printing questions.*

---

## 🎯 Why This Matters

Klipper's documentation is comprehensive but scattered across dozens of markdown files. Finding the right configuration option or troubleshooting guide means multiple clicks and searches. **This changes everything.**

### The Problem
- 🔍 **Fragmented Documentation**: 50+ separate markdown files
- 🐛 **Configuration Complexity**: Hard to find specific option details
- ⏱️ **Context Switching**: Jump between docs and your config files
- 🤖 **AI Limitations**: Claude can't access local Klipper docs

### The Solution
- 🔎 **Unified Search**: Search all documentation instantly
- ⚙️ **Smart Config Lookup**: Get exact configuration sections
- 📚 **Intelligent Browsing**: Navigate by logical categories
- 🤖 **AI Integration**: Claude becomes your Klipper expert

---

## 🚀 Quick Start

### Prerequisites

- **Node.js** >= 20.0.0
- **npm** or **yarn**
- **Claude Desktop** (for MCP integration)

### Installation

```bash
# Install globally
npm install -g mcp-klipper-docs

# Or install locally in your project
npm install mcp-klipper-docs
```

### Claude Desktop Setup

1. **Open your Claude Desktop config file**:
   - **Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
   - **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`

2. **Add the MCP server**:

#### Option 1: Global Installation (Recommended)
```json
{
  "mcpServers": {
    "klipper-docs": {
      "command": "node",
      "args": ["C:\\Users\\bpuhnk\\AppData\\Roaming\\npm\\node_modules\\mcp-klipper-docs\\dist\\server.js"]
    }
  }
}
```

#### Option 2: Using npx
```json
{
  "mcpServers": {
    "klipper-docs": {
      "command": "npx",
      "args": ["-y", "mcp-klipper-docs@1.0.1"]
    }
  }
}
```

#### Option 3: Local Development
```json
{
  "mcpServers": {
    "klipper-docs": {
      "command": "node",
      "args": ["C:\\Users\\bpuhnk\\source\\repos\\MCP_Klipper\\dist\\server.js"]
    }
  }
}
```

3. **Restart Claude Desktop**

That's it! 🎉 Claude now has instant access to all Klipper documentation.

### 📦 Package Information

- **npm Package**: [mcp-klipper-docs](https://www.npmjs.com/package/mcp-klipper-docs)
- **Version**: 1.0.1
- **Repository**: [GitHub](https://github.com/bpuhnk/mcp-klipper-docs)
- **License**: MIT
- **Author**: Ben Phillips

### 🔍 Verification

After installation, verify everything works:

```bash
# Check package installation
npm list -g mcp-klipper-docs

# Test server startup
node C:\Users\bpuhnk\AppData\Roaming\npm\node_modules\mcp-klipper-docs\dist\server.js

# Or using npx
npx -y mcp-klipper-docs@1.0.1
```

---

## 🛠️ What Can You Do?

### 🔍 Search Documentation
```
"Search for BLTouch configuration"
"Find information about pressure advance"
"Look up extruder tuning guides"
```

### ⚙️ Get Configuration Details
```
"Get configuration for [extruder]"
"Show me stepper_x settings"
"What are the bed_mesh parameters?"
```

### 📚 Browse by Section
```
"Browse calibration documentation"
"Show me hardware configuration sections"
"What's in the troubleshooting section?"
```

### 📊 Get Statistics
```
"How many documents are available?"
"What sections exist in the documentation?"
"Show me index statistics"
```

---

## 🏗️ Architecture

### Core Components

```mermaid
graph TD
    A[Claude Desktop] --> B[MCP Protocol]
    B --> C[MCP Server]
    C --> D[Search Engine]
    C --> E[Document Parser]
    C --> F[Git Sync]
    D --> G[Lunr.js Index]
    E --> H[Markdown Files]
    F --> I[Klipper Repository]
```

### Technology Stack

| Component | Technology | Purpose |
|-----------|------------|---------|
| **Runtime** | Node.js 20+ | JavaScript execution |
| **Language** | TypeScript 5.3+ | Type safety & development |
| **Protocol** | MCP SDK 1.0+ | Claude Desktop integration |
| **Search** | Lunr.js 2.3+ | Full-text search indexing |
| **Git** | simple-git 3.22+ | Repository synchronization |
| **Parsing** | marked 11.1+ | Markdown processing |
| **Metadata** | gray-matter 4.0+ | Frontmatter extraction |

### Data Flow

1. **Repository Sync**: Automatically pulls latest Klipper documentation
2. **Document Parsing**: Extracts content, metadata, and structure
3. **Index Building**: Creates searchable lunr.js index
4. **MCP Integration**: Exposes tools and resources via MCP protocol
5. **AI Interaction**: Claude searches and retrieves documentation

---

## 📋 Available Tools

### 🔎 `search_klipper_docs`
Search across all Klipper documentation with relevance scoring.

**Parameters**:
- `query` (string): Search terms
- `limit` (number, optional): Max results (default: 10)
- `section` (string, optional): Filter by section

**Example**:
```json
{
  "query": "BLTouch configuration",
  "limit": 5,
  "section": "hardware"
}
```

### ⚙️ `get_config_option`
Retrieve specific configuration sections from Config_Reference.

**Parameters**:
- `option` (string): Configuration option name
- `include_examples` (boolean, optional): Include code examples

**Example**:
```json
{
  "option": "extruder",
  "include_examples": true
}
```

### 📚 `browse_documentation`
Browse documentation by section or get overview information.

**Parameters**:
- `section` (string, optional): Section to browse
- `include_stats` (boolean, optional): Include statistics

**Example**:
```json
{
  "section": "calibration",
  "include_stats": true
}
```

### 📊 `get_index_stats`
Get documentation index statistics and metadata.

**No parameters required.**

---

## 📁 MCP Resources

All documentation files are available as MCP resources:

- **URI Scheme**: `klipper://docs/{document-id}`
- **Format**: Markdown with metadata
- **Access**: Direct file reading or browsing

**Example Resources**:
- `klipper://docs/Config_Reference`
- `klipper://docs/BLTouch`
- `klipper://docs/Installation`
- `klipper://docs/Troubleshooting`

---

## 🔧 Advanced Configuration

### Environment Variables

| Variable | Default | Description |
|----------|---------|-------------|
| `GIT_REPOSITORY` | `https://github.com/Klipper3d/klipper.git` | Klipper repository URL |
| `GIT_BRANCH` | `master` | Repository branch |
| `DATA_DIR` | `./data` | Local data directory |
| `LOG_LEVEL` | `info` | Logging level (debug, info, warn, error) |
| `UPDATE_INTERVAL` | `3600` | Auto-update interval in seconds |

### Docker Deployment

```bash
# Build the image
docker build -t mcp-klipper-docs .

# Run the container
docker run -d \
  --name mcp-klipper-docs \
  -v $(pwd)/data:/app/data \
  mcp-klipper-docs
```

### Docker Compose

```yaml
version: '3.8'
services:
  mcp-klipper-docs:
    build: .
    container_name: mcp-klipper-docs
    volumes:
      - ./data:/app/data
    environment:
      - LOG_LEVEL=info
      - UPDATE_INTERVAL=3600
    restart: unless-stopped
```

---

## 📊 Performance Metrics

### Index Statistics
- **Documents**: 56 Klipper documentation files
- **Words**: 135,000+ indexed words
- **Sections**: 11 categorized sections
- **Build Time**: ~400ms for full index
- **Search Speed**: 

**⭐ If this project helps you, consider giving it a star!**

Made with ❤️ by the 3D printing community, for the 3D printing community.

[🔝 Back to top](#-mcp-klipper-documentation-server)

## Source & license

This open-source MCP server is cataloged on AgentStack and links to its original source — we do not rehost the code.

- **Author:** [bpuhnk](https://github.com/bpuhnk)
- **Source:** [bpuhnk/mcp-klipper-docs](https://github.com/bpuhnk/mcp-klipper-docs)
- **License:** MIT

Install and usage instructions live in the source repository linked above.

## Pricing

- **Free** — Free

## Security capabilities

Automated source analysis of v0.1.0 — what this tool can access:

- **Network access:** no
- **Filesystem access:** no
- **Shell / process execution:** no
- **Environment & secrets:** no
- **Dynamic code execution:** no

*"Yes" means the capability is present in the source — more access means more to trust, not that it is unsafe.*


## Versions

- **0.1.0** — security scan: passed — Imported from the upstream source.

## Links

- Listing page: https://agentstack.voostack.com/l/mcp-bpuhnk-mcp-klipper-docs
- Seller: https://agentstack.voostack.com/s/bpuhnk
- Browse the marketplace: https://agentstack.voostack.com/browse

---
Listed on AgentStack — the marketplace for AI agent skills and MCP servers. Every listing is security-reviewed. Creators keep 70%.