Prototype · Preview: every server in the official registry, synced every 30 minutes. Sign in with Google to write reviews.Prototype · updated every 30 min
PopNx MCPMCP servers for people who use AI · explained in plain words Sign in

NovelAI Image MCP

by xinvxueyuanversion 0.7.1i★ 12iRuns on your computerOfficial site ↗
Registry nameio.github.xinvxueyuan/novelai-image-mcp

How to install

What it does

NovelAI image generation as MCP tools: txt2img, img2img, inpaint, upscale, Director, ControlNet.

  • Connects Runs on your computer
  • Account or key Needs NOVELAI_TOKEN
  • Category Design, images & audio

Use together with

Skills that teach the AI this kind of work; they work alongside this one

impeccable

The design vocabulary for your coding agent. Steer with polish and bolder, review with critique and audit, catch AI slop before it ships.

by pbakaus★ 113,0421 skills

Skill · How-to guide

diagram-design

Editorial diagram design for Claude Code, Codex, GitHub Copilot, Cursor, Factory Droid, Qoder, and Pi. 45 diagram types. Self-contained HTML + SVG. No shadows. No Mermaid slop.

by cathrynlavery★ 68,2961 skills

Skill · How-to guide

frontend-slides

Create beautiful slides on the web using a coding agent's frontend skills

by zarazhangrui★ 32,5791 skills

Skill · How-to guide

Why it ranks here

Lists are ordered by a usage score (out of 100) built from these parts

Popularity13/80GitHub stars or weekly downloads: the larger counts 60, the smaller 20
Freshness12/12Full marks for a release or code change within 30 days
Still answering0/8The cloud endpoint answered at the last check
Usage score25/100

Quality: Passed 3/3 basic checks (shown, not used for ordering) · Momentum: No data yet (Used only on the Trending tab)

Install

Pick the AI app you use, then copy the settings.

Let your AI install it with one sentence

Please install NovelAI Image MCP. Follow https://mcp.popnx.com/i/xinvxueyuan-novelai-image-mcp.md, show me the commands and wait for my OK before running them.

Paste it into an AI that can work on your computer (such as Claude Code or Cursor). It reads our steps, shows you the commands and waits for your OK. No key, no sign-up. · See the full text your AI reads

Passed 3/3 checks · Runs on your computer · ✓ Commands checked Nov 20, 2026

First: which AI do you use?

Pick your app and the steps appear below.

Works with Claude, with some setup first

You need a NovelAI Image MCP key (create it on the maker’s site) · Install Python (uv) on your computer first (one time) · Only the Claude desktop app (Windows or Mac), not the web or phone

Let AI install it

Copy this message into a Claude chat. The AI checks your computer, tells you which file it will change, and waits for your OK every time.

Please install the MCP server NovelAI Image MCP for Claude on this computer, in this order: 1) Check uv with uv --version. If it is missing, tell me to install it from https://docs.astral.sh/uv/getting-started/installation/; do not install it yourself. 2) Use only this config (already checked by PopNx MCP): { "mcpServers": { "novelai-image": { "command": "uvx", "args": [ "novelai-image-mcp" ], "env": { "NOVELAI_TOKEN": "your-value" } } } } 3) Tell me the full path of the file you will change, or the command you will run, and wait for my OK. 4) For NOVELAI_TOKEN, leave "your-value" in place and tell me to paste the real value myself into the file or the app’s field. Never ask me to type a key in chat. 5) Do what we agreed, then check that the NovelAI Image MCP tools really show up.

This message has no key in it. If a key is needed, the AI will ask you to paste it yourself into the file or the app’s field.

  1. Install uv (if you don’t have it)

    Already installed? Check first · Open Terminal, type this command and press Enter

    uv --version
    • A version number such as uv … = installed, skip this step
    • "command not found" (on Windows: "is not recognized") = not installed yet, or installed but Terminal needs to be closed and reopened
    How to open Terminal

    Mac: press ⌘ + Space, type Terminal, press Enter

    Windows: open Start, type Windows PowerShell, then Open

    Not installed: uv has no click-through installer. Copy the one-line command for your system (macOS or Windows) from uv’s official page into Terminal · no separate Python install needed; uv downloads it when required

    Open the uv download page ↗

    When it’s done, close Terminal, open it again and run the same command. You should see a version number: uv --version

    Install once; it works for everything that needs uv

  2. Sign up and create a NovelAI Image MCP key

    Open the maker’s site, sign up and create an API key for the next step. Check the maker’s site for pricing and free plans.

    Open the NovelAI Image MCP site ↗

  3. Open the Claude desktop app’s settings file

    SettingsDeveloperEdit Config

  4. Paste these settings and save the file

    {
      "mcpServers": {
        "novelai-image": {
          "command": "uvx",
          "args": [
            "novelai-image-mcp"
          ],
          "env": {
            "NOVELAI_TOKEN": "your-value"
          }
        }
      }
    }

    Paste the key only into the app’s field, never into a chat or to anyone

  5. Quit Claude and open it again

  6. Try it

    Use NovelAI Image MCP and tell me what you can do for me, then show me one thing

    ✓ If Claude says it is using NovelAI Image MCP or shows a NovelAI Image MCP tool in the answer, you are connected

Menu names checked against Anthropic’s help page on Nov 11, 2026 · your screen may differ slightly by app version

ChatGPT cannot connect NovelAI Image MCP yet

NovelAI Image MCP runs on your computer, but ChatGPT can only connect servers that run on the web

What you can do instead

A · Use an app that can connect NovelAI Image MCP

  • You need a NovelAI Image MCP key (create it on the maker’s site) · Install Python (uv) on your computer first (one time) · Only the Claude desktop app (Windows or Mac), not the web or phone
  • You need a NovelAI Image MCP key (create it on the maker’s site) · Install Python (uv) on your computer first (one time)
  • You need a NovelAI Image MCP key (create it on the maker’s site) · Install Python (uv) on your computer first (one time)
  • You need a NovelAI Image MCP key (create it on the maker’s site) · Install Python (uv) on your computer first (one time)

B · Others in Design, images & audio that work with ChatGPT

Picked from the most used in the same category, only ones that connect by address with no key

Works with Claude Code, with some setup first

You need a NovelAI Image MCP key (create it on the maker’s site) · Install Python (uv) on your computer first (one time)

Let AI install it

Copy this message into a Claude Code chat. The AI checks your computer, tells you which file it will change, and waits for your OK every time.

Please install the MCP server NovelAI Image MCP for Claude Code on this computer, in this order: 1) Check uv with uv --version. If it is missing, tell me to install it from https://docs.astral.sh/uv/getting-started/installation/; do not install it yourself. 2) Use only this config (already checked by PopNx MCP): claude mcp add --scope user novelai-image --env NOVELAI_TOKEN=your-value -- uvx novelai-image-mcp 3) Tell me the full path of the file you will change, or the command you will run, and wait for my OK. 4) For NOVELAI_TOKEN, leave "your-value" in place and tell me to paste the real value myself into the file or the app’s field. Never ask me to type a key in chat. 5) Do what we agreed, then check that the NovelAI Image MCP tools really show up.

This message has no key in it. If a key is needed, the AI will ask you to paste it yourself into the file or the app’s field.

  1. Install uv (if you don’t have it)

    Already installed? Check first · Open Terminal, type this command and press Enter

    uv --version
    • A version number such as uv … = installed, skip this step
    • "command not found" (on Windows: "is not recognized") = not installed yet, or installed but Terminal needs to be closed and reopened
    How to open Terminal

    Mac: press ⌘ + Space, type Terminal, press Enter

    Windows: open Start, type Windows PowerShell, then Open

    Not installed: uv has no click-through installer. Copy the one-line command for your system (macOS or Windows) from uv’s official page into Terminal · no separate Python install needed; uv downloads it when required

    Open the uv download page ↗

    When it’s done, close Terminal, open it again and run the same command. You should see a version number: uv --version

    Install once; it works for everything that needs uv

  2. Sign up and create a NovelAI Image MCP key

    Open the maker’s site, sign up and create an API key for the next step. Check the maker’s site for pricing and free plans.

    Open the NovelAI Image MCP site ↗

  3. Open Terminal

    Mac: press Command+Space and type Terminal · Windows: open PowerShell

  4. Paste this command and press Enter

    claude mcp add --scope user novelai-image --env NOVELAI_TOKEN=your-value -- uvx novelai-image-mcp

    Replace “your-value” with your key before pressing Enter

    Paste the key only into the app’s field, never into a chat or to anyone

  5. Type /mcp in Claude Code

    You should see NovelAI Image MCP listed as connected

  6. Try it

    Use NovelAI Image MCP and tell me what you can do for me, then show me one thing

    ✓ If Claude Code says it is using NovelAI Image MCP or shows a NovelAI Image MCP tool in the answer, you are connected

Menu names checked against Anthropic’s help page on Nov 11, 2026 · your screen may differ slightly by app version

Works with Cursor, with some setup first

You need a NovelAI Image MCP key (create it on the maker’s site) · Install Python (uv) on your computer first (one time)

Let AI install it

Copy this message into a Cursor chat. The AI checks your computer, tells you which file it will change, and waits for your OK every time.

Please install the MCP server NovelAI Image MCP for Cursor on this computer, in this order: 1) Check uv with uv --version. If it is missing, tell me to install it from https://docs.astral.sh/uv/getting-started/installation/; do not install it yourself. 2) Use only this config (already checked by PopNx MCP): { "mcpServers": { "novelai-image": { "command": "uvx", "args": [ "novelai-image-mcp" ], "env": { "NOVELAI_TOKEN": "your-value" } } } } 3) Tell me the full path of the file you will change, or the command you will run, and wait for my OK. 4) For NOVELAI_TOKEN, leave "your-value" in place and tell me to paste the real value myself into the file or the app’s field. Never ask me to type a key in chat. 5) Do what we agreed, then check that the NovelAI Image MCP tools really show up.

This message has no key in it. If a key is needed, the AI will ask you to paste it yourself into the file or the app’s field.

  1. Install uv (if you don’t have it)

    Already installed? Check first · Open Terminal, type this command and press Enter

    uv --version
    • A version number such as uv … = installed, skip this step
    • "command not found" (on Windows: "is not recognized") = not installed yet, or installed but Terminal needs to be closed and reopened
    How to open Terminal

    Mac: press ⌘ + Space, type Terminal, press Enter

    Windows: open Start, type Windows PowerShell, then Open

    Not installed: uv has no click-through installer. Copy the one-line command for your system (macOS or Windows) from uv’s official page into Terminal · no separate Python install needed; uv downloads it when required

    Open the uv download page ↗

    When it’s done, close Terminal, open it again and run the same command. You should see a version number: uv --version

    Install once; it works for everything that needs uv

  2. Sign up and create a NovelAI Image MCP key

    Open the maker’s site, sign up and create an API key for the next step. Check the maker’s site for pricing and free plans.

    Open the NovelAI Image MCP site ↗

  3. Click this button to open Cursor

    Open in Cursor

    Cursor asks you to confirm; click Install

  4. Fill in your key

    In the NovelAI Image MCP settings, NOVELAI_TOKEN is empty; add your key and save

    Paste the key only into the app’s field, never into a chat or to anyone

  5. Open the AI chat in Cursor in Agent mode

  6. Try it

    Use NovelAI Image MCP and tell me what you can do for me, then show me one thing

    ✓ If Cursor says it is using NovelAI Image MCP or shows a NovelAI Image MCP tool in the answer, you are connected

Menu names checked against Cursor’s help page on Nov 11, 2026 · your screen may differ slightly by app version

Works with VS Code, with some setup first

You need a NovelAI Image MCP key (create it on the maker’s site) · Install Python (uv) on your computer first (one time)

Let AI install it

Copy this message into a VS Code chat. The AI checks your computer, tells you which file it will change, and waits for your OK every time.

Please install the MCP server NovelAI Image MCP for VS Code on this computer, in this order: 1) Check uv with uv --version. If it is missing, tell me to install it from https://docs.astral.sh/uv/getting-started/installation/; do not install it yourself. 2) Use only this config (already checked by PopNx MCP): { "servers": { "novelai-image": { "type": "stdio", "command": "uvx", "args": [ "novelai-image-mcp" ], "env": { "NOVELAI_TOKEN": "your-value" } } } } 3) Tell me the full path of the file you will change, or the command you will run, and wait for my OK. 4) For NOVELAI_TOKEN, leave "your-value" in place and tell me to paste the real value myself into the file or the app’s field. Never ask me to type a key in chat. 5) Do what we agreed, then check that the NovelAI Image MCP tools really show up.

This message has no key in it. If a key is needed, the AI will ask you to paste it yourself into the file or the app’s field.

  1. Install uv (if you don’t have it)

    Already installed? Check first · Open Terminal, type this command and press Enter

    uv --version
    • A version number such as uv … = installed, skip this step
    • "command not found" (on Windows: "is not recognized") = not installed yet, or installed but Terminal needs to be closed and reopened
    How to open Terminal

    Mac: press ⌘ + Space, type Terminal, press Enter

    Windows: open Start, type Windows PowerShell, then Open

    Not installed: uv has no click-through installer. Copy the one-line command for your system (macOS or Windows) from uv’s official page into Terminal · no separate Python install needed; uv downloads it when required

    Open the uv download page ↗

    When it’s done, close Terminal, open it again and run the same command. You should see a version number: uv --version

    Install once; it works for everything that needs uv

  2. Sign up and create a NovelAI Image MCP key

    Open the maker’s site, sign up and create an API key for the next step. Check the maker’s site for pricing and free plans.

    Open the NovelAI Image MCP site ↗

  3. Click this button to open VS Code

    Open in VS Code

    VS Code asks you to confirm; click Install

  4. Fill in your key

    In the NovelAI Image MCP settings, NOVELAI_TOKEN is empty; add your key and save

    Paste the key only into the app’s field, never into a chat or to anyone

  5. Open the AI chat in VS Code in Agent mode

  6. Try it

    Use NovelAI Image MCP and tell me what you can do for me, then show me one thing

    ✓ If VS Code says it is using NovelAI Image MCP or shows a NovelAI Image MCP tool in the answer, you are connected

Menu names checked against VS Code’s help page on Nov 11, 2026 · your screen may differ slightly by app version

Other apps that use MCP, such as Windsurf, Zed or Gemini CLI, each add servers differently. See how in the app list.

See every app that uses MCP →

JSON settings are under “For developers” below

Stuck? Ask people who use NovelAI Image MCP💬 Discussion →
For developers: Terminal commands and JSON settings

Installed on your computer

Claude Code

claude mcp add --scope user novelai-image --env NOVELAI_TOKEN=your-value -- uvx novelai-image-mcp

Claude Desktop (claude_desktop_config.json)

{
  "mcpServers": {
    "novelai-image": {
      "command": "uvx",
      "args": [
        "novelai-image-mcp"
      ],
      "env": {
        "NOVELAI_TOKEN": "your-value"
      }
    }
  }
}

Cursor (~/.cursor/mcp.json)

{
  "mcpServers": {
    "novelai-image": {
      "command": "uvx",
      "args": [
        "novelai-image-mcp"
      ],
      "env": {
        "NOVELAI_TOKEN": "your-value"
      }
    }
  }
}

VS Code (mcp.json)

{
  "servers": {
    "novelai-image": {
      "type": "stdio",
      "command": "uvx",
      "args": [
        "novelai-image-mcp"
      ],
      "env": {
        "NOVELAI_TOKEN": "your-value"
      }
    }
  }
}

Values you fill in

  • NOVELAI_TOKEN secret required env
    NovelAI persistent API token (preferred auth). Get from https://novelai.net/account

Descriptions are as written by the maker.

These settings are generated from the maker’s registry entry. If the README says otherwise, follow the README.

At a glance

Downloads per weeki
239/wk
Connection
Runs on your computer
Latest versioni
0.7.1
Published to registryi
Oct 31, 2026
Code last changedi
Nov 16, 2026
Maker
xinvxueyuan
Packages
pypi: novelai-image-mcp
oci: ghcr.io/xinvxueyuan/novelai-image-mcp:0.7.1
Registry status
Active

Which apps can use it

Based on how this server connects and on each app’s own docs, checked Nov 10, 2026.

Run on your computer in

ClaudeGooseLM StudioMsty StudioCherry StudioCursorVS Code + GitHub CopilotVisual StudioWindsurf (Devin Desktop)ZedKiroClineContinueJetBrains AI AssistantClaude CodeCodex CLIGemini CLIOpenCodenodecodeWarpLibreChatRaycast

All apps, with pros and cons →

Related guides

What it can do

Runs on your computer; the tool list appears in your AI app after you install it.

Basic checksi

We check information anyone can see; we have not read the code. Checks that do not apply are left out of the count. · Checked Nov 20, 2026

  • ✓ Pass

    Maker matches the repo

    The registry name was verified with the GitHub account xinvxueyuan, which owns the repo

  • ✓ Pass

    Still maintained

    Code last changed 4 days ago

  • ✓ Pass

    Has a licence

    Uses MIT

  • – Not applicable

    Endpoint responds

    This one runs on your computer; there is no internet endpoint

  • – Not applicable

    Sign-in with OAuth

    Runs on your computer and uses local settings instead

  • … Not checked yet

    No hidden instructions in tool descriptions

    Runs on your computer; we can only read tool lists from internet endpoints

Published vulnerabilities (OSV.dev)

No entries on OSV.dev for novelai-image-mcp@0.7.1

Checks only this package version, not every dependency · checked Nov 15, 2026

What we check → · JSON

Makers: ask for a re-check or report wrong info
For makers: add a badge to your README

If you made this, paste this code into your README. The badge links back to this page.

[![Featured on PopNx MCP](https://mcp.popnx.com/badge/xinvxueyuan-novelai-image-mcp.svg)](https://mcp.popnx.com/en/servers/xinvxueyuan-novelai-image-mcp)

Discussion

Ask, share a tip or report that it does not work. Sorted by what people marked helpful.

No posts yet. Be the first to ask or share.

Posts here are written by users, not the PopNx team.

Sign in to post

User reviews

No reviews yet

Sign in to write a review

Compared with others in Design, images & audioi

  • More stars than 94% of the other 3313 servers in this category
  • Published to the registry more recently than 63% of the other 3313 servers in this category
  • Basic checks equal to or better than 99% of the other 3313 servers in this category

Compared with every active server in this category in the registry. Stars count only when the publisher owns the repo.

Common questions

Is NovelAI Image MCP safe?

It passed 3 of 3 applicable basic checks. We have not read the code. Before adding a key or token, see what access the server asks for and use a key with only the permissions you need.

What keys or codes does it need?

You need to fill in: NOVELAI_TOKEN

Does it run on my computer or in the cloud?

It runs on your computer. Your AI app starts it when needed, and data does not pass through the maker’s servers (unless it calls an online service itself).

Is it still maintained?

The GitHub repo last changed 4 days ago, and the latest version (0.7.1) reached the registry 20 days ago.

Which apps can use it?

Apps that support MCP, such as Claude Desktop, Claude Code, Cursor and VS Code. You also need Python (uv), Docker on your computer.

What can I use instead?

In the same category: HyperFrames by HeyGen, Pascal 3D Editor, draw.io, Figma MCP Server, Remocn: Remotion MCP server

Similar alternatives

Same category, other makers, commands already checked. Official ones first, then by stars.

Reading a card:↓ Downloads per weeki★ GitHub starsiThree pillars: reviews · checks · usageiUpdated = latest version published to the registryi

HyperFrames by HeyGen

Official HyperFrames by HeyGen: the best AI video editor in chat. Captions, motion graphics, MP4.

by heygen-comWidely used★ 86.8K Stars for the whole repoUpdated 2 days ago

Runs in the cloud✓ heygen.com

Pascal 3D Editor

Create, inspect, validate, and save editable 3D building scenes with Pascal's MCP server.

by pascalorgWidely used↓ 1K/wk★ 25.6K Stars for the whole repoUpdated 2 days ago

Computer or cloud✓ service owner · pascal.app

draw.io

Create draw.io diagrams in chat from Mermaid or XML, shown live and interactive. 10,000+ shapes.

by jgraphWidely used★ 5.9KUpdated 3 days ago

Runs in the cloud✓ service owner · draw.ioTried by the PopNx team

Figma MCP Server

Figma’s official server gives AI your design data so it can turn designs into code or describe them accurately. Connects to Figma’s cloud.

by figmaWidely used★ 2.2KUpdated 13 months ago

Runs in the cloud✓ service owner · mcp.figma.com
Compared with similar ones
This one
NovelAI Image MCP
HyperFrames by HeyGenPascal 3D Editordraw.ioFigma MCP ServerRemocn: Remotion MCP server
Runs whereInstalls on your computerRuns in the cloud, nothing to installCloud or install on your computerRuns in the cloud, nothing to installRuns in the cloud, nothing to installRuns in the cloud, nothing to install
Needs a keyYesNoNoNoNoNo
Add with + in ClaudeNoYesNoNoYesNo
Basic checks3/34/45/54/44/44/4
LicenseMITApache-2.0MITApache-2.0–MIT
PriceNo cost listed in the registryNo cost listed in the registryNo cost listed in the registryNo cost listed in the registryNo cost listed in the registryNo cost listed in the registry

README from the maker

Open the README

Copied from the maker’s repo as written. PopNx MCP has not reviewed or endorsed it. HTML, images and scripts are removed. Links lead off this site.

NovelAI Image MCP

Languages

English简体中文日本語
English简体中文日本語

[][ci-workflow] [][docs] [][license] [][python] [][uv] [][reuse] [][deepwiki] [][skills-sh]

[][product-hunt] [][lifto]

An MCP (Model Context Protocol) server that exposes NovelAI image generation to AI agents (Claude Desktop, Cline, custom agents, remote clients), plus a sync CLI and three skills.sh packages that teach those agents how to drive either surface.

Built on FastMCP 4 (the fastmcp framework over the MCP SDK v2 mcp>=2.3.0), it covers txt2img / img2img / inpaint, 4× upscale, Director tools (line art, emotion, background removal, …), ControlNet annotation, tag suggestions, vibe encoding and account subscription — all through the standard MCP tool interface.

📖 Documentation: xinvxueyuan.github.io/NovelAI-Image-MCP

Three ways to drive it

All three wrap the same async NovelAIClient; they differ in how you invoke it.

  • MCP tools — interactive agent sessions (Claude Desktop, Cline, …). The agent sees base64 Image content blocks.
  • CLI — shell scripting, CI jobs, one-off commands. Saves a PNG and prints its path; no image blocks.
  • Agent skills — portable instructions that tell an agent how to use the other two. They inherit the mode they drive.

Features

  • 11 MCP tools covering the full NovelAI image API surface.
  • 2 prompts + 3 resources + 1 resource template: house-style prompt drafting and tool sequencing (novelai_prompt_writer, novelai_image_workflow), plus novelai://models, novelai://samplers, novelai://defaults and novelai://outputs/{name} for discovering the model/sampler vocabulary and reading generated PNGs back.
  • Three agent skills (novelai-cli, novelai-mcp-tools, novelai-workflows) grouped as CLI / MCP Tools / Workflows, installable with one npx skills add command.
  • A sync `typer` CLI with six subcommands for scripting outside an MCP host.
  • Two transports: stdio (local agents) + HTTP (remote / multi-client), the latter optionally protected by a bearer token (MCP_AUTH_TOKEN).
  • Opt-in routing and audit (HTTP): a client that sends X-MCP-Insiders gets per-route output directories, per-route loggers and an append-only JSONL audit trail (prompts and credentials are never written verbatim). Without the header nothing changes. See Insiders header, routing and audit.
  • Structured results: enum-validated tool schemas, MCP tool annotations and ToolError for expected failures.
  • Dual image return: base64 Image content blocks (the agent *sees* the image) and PNG saved to disk (path returned as text).
  • Monorepo: uv workspace (Python) + pnpm workspace (Node tooling) orchestrated by Turbo; MIT-licensed, Docker-ready, GitHub Pages docs.

Quick start

1. Install the agent skills
npx skills add --yes --global xinvxueyuan/NovelAI-Image-MCP

--yes skips the interactive picker; --global installs to ~/.agents/skills/ so every project on the machine can use them. Drop --global to install into the current project's .agents/skills/ instead. See Agent skills for what each skill covers.

2. Install the server (from source, development)
# 1. Clone

git clone https://github.com/xinvxueyuan/NovelAI-Image-MCP.git cd NovelAI-Image-MCP

2. Sync the uv workspace (installs server + docs + dev tools)

uv sync

3. Configure credentials

cp .env.example .env

set NOVELAI_TOKEN=... (preferred)

or NOVELAI_USERNAME + NOVELAI_PASSWORD

4. Run (stdio — for local agents)

uv run python -m novelai_image_mcp serve

5. Or over HTTP

MCP_TRANSPORT=http uv run python -m novelai_image_mcp serve

→ http://127.0.0.1:8000/mcp

3. Install the server (PyPI, runtime only)
pip install novelai-image-mcp

export NOVELAI_TOKEN=pst-... novelai-image-mcp serve

Optional: Node tooling (contributors)

If you plan to contribute, install the cross-cutting Node toolchain (turbo, husky, markdownlint) via pnpm:

corepack enable pnpm      # one-time

pnpm install --frozen-lockfile

This wires the husky pre-commit + commit-msg hooks and gives you turbo / markdownlint-cli2 for local development. The MCP server has zero Node runtime dependencies — this step is only for contributors.

Connect an agent

The MCP server supports two transports (stdio + http), all configured under mcpServers:

stdio (local agent — Claude Desktop / Cline)

claude_desktop_config.json:

{

"mcpServers": { "novelai-image": { "type": "stdio", "command": "uv", "args": [ "run", "--directory", "/path/to/NovelAI-Image-MCP", "python", "-m", "novelai_image_mcp", "serve" ], "env": { "NOVELAI_TOKEN": "${input:novelai_token}" } } } }

Alternative: uvx (published package)
{

"mcpServers": { "novelai-image": { "command": "uvx", "args": ["novelai-image-mcp", "serve"], "env": { "NOVELAI_TOKEN": "pst-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" } } } }

Set NOVELAI_TOKEN (or NOVELAI_USERNAME + NOVELAI_PASSWORD) in the host environment before launching — uvx inherits the parent shell env.

http (remote / Docker deployment)

After docker compose up --build (server listens on http://HOST:8000/mcp):

{

"mcpServers": { "novelai-image-http": { "type": "http", "url": "http://127.0.0.1:8000/mcp", "headers": { "Authorization": "Bearer pst-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" } } } }

Replace http://127.0.0.1:8000/mcp with your self-deployed endpoint (e.g. https://mcp.example.com/mcp behind a TLS-terminating reverse proxy). Swap the literal token placeholder for a host-managed secret reference if your MCP host supports one (Claude Desktop, Cline, etc. expose this via their own secrets UI).

Standard FastMCP entry points

The repository ships a fastmcp.json whose source points at apps/server/mcp_server.py, so plain FastMCP tooling works too (run from the repository root, after uv sync):

uv run fastmcp run fastmcp.json                     # stdio server

uv run fastmcp inspect # list tools/prompts/resources uv run --directory apps/server fastmcp dev inspector mcp_server.py # Inspector

fastmcp.json has no environment block on purpose: the workspace virtualenv already has the package installed, and an environment entry would make FastMCP build a second, throwaway environment for every run.

CLI (sync, for scripting)

The CLI exposes six subcommands: serve, generate, upscale, director, annotate, info.

# Run the MCP server (stdio by default; -t http for the HTTP transport)

novelai-image-mcp serve

Text-to-image — prints one absolute PNG path per generated image

novelai-image-mcp generate --prompt "a cat, masterpiece" --width 832 --height 1216

4x upscale (V5 model only)

novelai-image-mcp upscale --image ./in.png --factor 4

Director tools: lineart | sketch | bg-removal | declutter | colorize | emotion

novelai-image-mcp director lineart ./photo.png --defry 5

ControlNet annotation: hed | midas | fake_scribble | mlsd | uniformer

novelai-image-mcp annotate ./photo.png --model hed

Subscription / Anlas balance

novelai-image-mcp info

novelai-image-mcp --help

Install it with pip install novelai-image-mcp, run it ad hoc with uvx novelai-image-mcp , or from the monorepo with uv run --directory apps/server novelai-image-mcp . Every image-producing command saves a PNG to NOVELAI_OUTPUT_DIR (default outputs) and prints its path; -o / --output-dir overrides the directory for one invocation. The full flag list lives in the novelai-cli skill.

Agent skills

Three skills.sh packages ship in skills/. They teach AI agents (Claude Code, Codex, GitHub Copilot, Cursor, …) how to drive the CLI and the MCP tools, so you do not have to paste docs into the conversation.

npx skills add --yes --global xinvxueyuan/NovelAI-Image-MCP
graph TD

Q{How will you drive NovelAI?} Q -->|"Interactive session with an MCP host"| MCP["MCP tools 11 tools over stdio / http"] Q -->|"Shell script, CI job, one-off command"| CLI["CLI novelai-image-mcp generate ..."] Q -->|"Let an agent pick the right one"| SK["Agent skills novelai-cli / novelai-mcp-tools / novelai-workflows"] SK --> MCP SK --> CLI

SkillGroupWhat it teaches
novelai-cliCLITyper CLI commands (serve, generate, upscale, director, annotate, info) for shell scripting
novelai-mcp-toolsMCP ToolsThe 11 MCP tools — model selection, parameters, return shape, Anlas cost
novelai-workflowsWorkflowsMulti-step creative pipelines (txt2img→upscale, annotate→img2img, Director edits)

Skills and the CLI/MCP tools are complementary, not either/or: install all three and the agent picks the mode that fits the task. Each skill points at the other two instead of repeating them. See the Agent skills docs for the group descriptions and a mode-comparison table.

Repository layout

This is a uv + pnpm monorepo:

NovelAI-Image-MCP/

├── apps/ │ ├── server/ # MCP server (the installable PyPI package) │ │ ├── src/novelai_image_mcp/ # 11 MCP tools + NovelAI HTTP client │ │ ├── tests/ │ │ ├── docker/ # smoke-test entrypoint │ │ ├── Dockerfile # built with repo root as context │ │ └── pyproject.toml # ruff / pyright / pytest config │ └── docs/ # Sphinx documentation site │ ├── source/ # MyST Markdown + conf.py │ ├── Makefile │ └── pyproject.toml ├── skills/ # skills.sh packages (novelai-cli, ...) ├── skills.sh.json # skill groupings for skills.sh ├── .github/ # workflows, CODEOWNERS, issue templates ├── pyproject.toml # uv workspace root (virtual) ├── uv.lock # single shared lockfile ├── pnpm-workspace.yaml # pnpm workspace declaration ├── pnpm-lock.yaml # Node toolchain lockfile ├── turbo.json # cross-workspace task graph ├── package.json # root scripts + dev toolchain └── docker-compose.yml # local container orchestration

See CONTRIBUTING.md for the developer guide and apps/docs/source/ for the full documentation source.

Tools

ToolDescription
generate_imageText-to-image (V3 / V4 / V4.5 / V5 models, character prompts; vibes V4/V4.5 only)
image_to_imageImage-to-image with strength/noise
inpaintInpainting (requires an inpaint model + mask)
upscale_image4× upscale (V5 model)
director_toolLine art / sketch / bg-removal / declutter / colorize / emotion
annotate_imageControlNet annotation (hed, midas, scribble, mlsd, uniformer)
suggest_tagsPrompt tag suggestions
encode_vibeEncode a reference image into a vibe token
get_subscriptionAccount subscription + Anlas balance
get_user_dataAccount user data
estimate_anlas_costEstimate Anlas cost for a generation (no API call)

See the [tools reference][tools-

Only the beginning is shown; read the rest in the repo