JUCE Docs

by josmithiii

15 stars
362 downloads
Not rated
GitHub

About

Parses JUCE Framework HTML documentation from Stanford CCRMA's website, converting class details into markdown-formatted resources for developers to easily search and retrieve C++ class information.

Details

Author
josmithiii
Repository
josmithiii/mcp-servers-jos
GitHub stars
15
Downloads
362
License
MIT License
Categories
Developer Tools, Design, Workplace, File Management, AI, Search, Infrastructure, Frontend, Other
Tags
#web

- Fetch documentation for specific JUCE classes
- List all available JUCE classes
- Search for classes by name
- Format documentation as markdown
- Expose documentation through MCP resources and tools
- Default docs source: https://docs.juce.com/master
- Switch docs source at runtime (master/develop/custom URL/local path)
- Optional local docs setup from a JUCE checkout path

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name JUCE Docs
    Command (node, npx, python, etc.) node
    Arguments
    • Argument 1 dist/index.js

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

npm install

If you want the easiest setup, follow these steps exactly.

1. Build once:

cd /path/to/mcp-servers-jos/juce-docs-mcp-server
npm install
npm run build

2. Add this MCP server to your client:

```bash

search-juce-classes

Search for JUCE classes by name.

get-juce-class-docs

Get documentation for a specific JUCE class.

get-juce-docs-config

Show current docs source and how to switch it.

set-juce-docs-source

Switch docs source (master/develop/custom/local).

setup-local-juce-docs

Point to a local JUCE checkout and optionally generate docs.

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "juce docs": {
            "cwd": "/path/to/mcp-servers-jos/juce-docs-mcp-server",
            "env": {},
            "args": [
                "dist/index.js"
            ],
            "command": "node"
        }
    }
}

Linux

{
    "cwd": "/path/to/mcp-servers-jos/juce-docs-mcp-server",
    "env": [],
    "args": [
        "dist/index.js"
    ],
    "command": "node"
}

Macos

{
    "cwd": "/path/to/mcp-servers-jos/juce-docs-mcp-server",
    "env": [],
    "args": [
        "dist/index.js"
    ],
    "command": "node"
}

Windows

{
    "cwd": "C:\\path\\to\\mcp-servers-jos\\juce-docs-mcp-server",
    "env": [],
    "args": [
        "/c",
        "node",
        "dist/index.js"
    ],
    "command": "cmd"
}

JUCE Documentation MCP Server

An MCP (Model Context Protocol) server that provides access to JUCE Framework C++ class documentation.

Features

- Fetch documentation for specific JUCE classes
- List all available JUCE classes
- Search for classes by name
- Format documentation as markdown
- Expose documentation through MCP resources and tools
- Default docs source: https://docs.juce.com/master
- Switch docs source at runtime (master/develop/custom URL/local path)
- Optional local docs setup from a JUCE checkout path

Installation

# Clone the repository
git clone https://github.com/josmithiii/mcp-servers-jos.git
cd mcp-servers-jos/juce-docs-mcp-server

Install dependencies

npm install

Build the project

npm run build

Usage

Quick Start (Simple Setup)

If you want the easiest setup, follow these steps exactly.

1. Build once:

cd /path/to/mcp-servers-jos/juce-docs-mcp-server
npm install
npm run build

2. Add this MCP server to your client:

# Codex
codex mcp add juce-docs -- node "$(pwd)/dist/index.js"

Claude Code

claude mcp add --scope user juce-docs -- node "$(pwd)/dist/index.js"

3. Check current docs source (default is JUCE master):

- Run tool get-juce-docs-config with args:

{}

4. If you want JUCE develop docs instead of master:

- Run tool set-juce-docs-source with args:

{
  "source": "develop"
}

5. If you want local docs from your JUCE checkout (faster, no docs network fetches):

- Run tool setup-local-juce-docs with args:

{
  "jucePath": "~/Code/JUCE",
  "generateIfMissing": true
}

generateIfMissing is only needed if local docs are not generated yet.

6. Switch back to hosted stable docs anytime:

- Run tool set-juce-docs-source with args:

{
  "source": "master"
}
No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.