NovelAI Image MCP
Languages
Project overview in your language (this page remains in English).
| English | 简体中文 | 日本語 |
|---|---|---|
| English | 简体中文 | 日本語 |
An MCP (Model Context Protocol) server that exposes NovelAI image generation as tools for AI agents (Claude Desktop, Cline, custom agents, remote clients).
Built on FastMCP 4 (the fastmcp framework over the MCP SDK v2 mcp>=2.0.0), it lets an agent generate
images (txt2img / img2img / inpaint), upscale, run Director tools (line art,
emotion, background removal, …), annotate with ControlNet, suggest tags, encode
vibes, and query account subscription — all through the standard MCP tool
interface.
This package is the server workspace member of the
NovelAI-Image-MCP
monorepo. The Sphinx documentation site lives at apps/docs/. See the
repository root README
for the project overview and the docs site
for full guides and API reference.
Features
- 11 MCP tools covering the full NovelAI image API surface.
- 2 prompts + 3 resources + 1 resource template: prompt templates for drafting and tool
sequencing, plus
novelai://models,novelai://samplers,novelai://defaultsandnovelai://outputs/{name}. - Transports: stdio (local agents) + HTTP (remote / multi-client), the
latter optionally protected by
MCP_AUTH_TOKEN. - Image return: base64
Imagecontent blocks (the agent sees the image) and PNG saved to disk (path returned as text). - Async + sync: async tool handlers + a
typerCLI for direct invocation.
Install
pip install novelai-image-mcp
Quick start
# 1. Configure credentials
export NOVELAI_TOKEN=pst-... # from https://novelai.net > Account
# 2. Run (stdio — for local agents)
novelai-image-mcp serve
# 3. Or over HTTP
MCP_TRANSPORT=http novelai-image-mcp serve
# → http://127.0.0.1:8000/mcp
Agent skills
Three skills.sh packages (novelai-cli,
novelai-mcp-tools, novelai-workflows) teach AI agents how to drive the
CLI and MCP tools:
npx skills add --yes --global xinvxueyuan/NovelAI-Image-MCP
License
MIT — see LICENSE. Per-file SPDX annotations live in REUSE.toml.
1 maintainer
Metadata
1 maintainer
Release files for novelai-image-mcp 0.6.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| novelai_image_mcp-0.6.1.tar.gz | 66.1 kB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| novelai_image_mcp-0.6.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 141.8 kB
Release files / novelai_image_mcp-0.6.1.tar.gz
| Download URL | novelai_image_mcp-0.6.1.tar.gz |
|---|---|
| Size | 66.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
79ff9047d0ecbe30a12b09e784add9415dd3ddd2a9f642f0401dde12ebd616e6
|
|
BLAKE2b-256 checksum How to use checksums |
275eb3a873c11505fcc36935fb441ef06a6235308940c6959f3c7628bb441dfc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 18, 2026.
Transparency logRelease files / novelai_image_mcp-0.6.1-py3-none-any.whl
| Download URL | novelai_image_mcp-0.6.1-py3-none-any.whl |
|---|---|
| Size | 75.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
90a439c9a673c3bcf606ea4a5fa9c84a5e32bfdcf64b39044fa6708796f8155a
|
|
BLAKE2b-256 checksum How to use checksums |
7a5bad8234a797f34bb1a5d8fc0b10151fb1178a154f0acdc0cb0d59744a50ba
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 18, 2026.
Transparency logSecurity for novelai-image-mcp 0.6.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for novelai_image_mcp-0.6.1.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 18, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
