Skip to main content

MCP server exposing NovelAI image generation as tools for AI agents

Project description

NovelAI Image MCP

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 the official MCP Python SDK v2 (MCPServer), 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.
  • Transports: stdio (local agents) + streamable-http (remote / multi-client).
  • Image return: base64 Image content blocks (the agent sees the image) and PNG saved to disk (path returned as text).
  • Async + sync: async tool handlers + a typer CLI 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=streamable-http novelai-image-mcp serve
#   → http://127.0.0.1:8000/mcp

License

MIT — see LICENSE. Per-file SPDX annotations live in REUSE.toml.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

novelai_image_mcp-0.1.5.tar.gz (36.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

novelai_image_mcp-0.1.5-py3-none-any.whl (43.9 kB view details)

Uploaded Python 3

File details

Details for the file novelai_image_mcp-0.1.5.tar.gz.

File metadata

  • Download URL: novelai_image_mcp-0.1.5.tar.gz
  • Upload date:
  • Size: 36.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for novelai_image_mcp-0.1.5.tar.gz
Algorithm Hash digest
SHA256 f8e9df402ef45291583ab264aed5244b23a696c758cb14930a61a1917855117e
MD5 d7355ab989320d117fe2d2b2f2575344
BLAKE2b-256 9c390f8d3e757f2c46834b8639d35633c2b9dca37da51e8f3eb2383365b56a01

See more details on using hashes here.

Provenance

The following attestation bundles were made for novelai_image_mcp-0.1.5.tar.gz:

Publisher: release.yml on xinvxueyuan/NovelAI-Image-MCP

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file novelai_image_mcp-0.1.5-py3-none-any.whl.

File metadata

File hashes

Hashes for novelai_image_mcp-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 ba71fa981db7e3a771dda0c68157c9b5522f2c62d80602b0abd245e463b73658
MD5 1b855ceab233cacff4a2932509ac229c
BLAKE2b-256 2df063b6933b68459ea175f54906b683c4bfcc0fba03cdb75dbb909bebe81dbc

See more details on using hashes here.

Provenance

The following attestation bundles were made for novelai_image_mcp-0.1.5-py3-none-any.whl:

Publisher: release.yml on xinvxueyuan/NovelAI-Image-MCP

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page