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.3.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.3-py3-none-any.whl (43.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: novelai_image_mcp-0.1.3.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.3.tar.gz
Algorithm Hash digest
SHA256 52abe3dba1be058b63bf2b81de4c356087c234d9d3788183a18ddfd0f569767a
MD5 38ca7e022198e174c2e9c7479c84f4e6
BLAKE2b-256 f2ff6442c234c5af9033d2fb075ec8ca9b81a1bd56fd7a2eda98bb31e3b5f0ab

See more details on using hashes here.

Provenance

The following attestation bundles were made for novelai_image_mcp-0.1.3.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.3-py3-none-any.whl.

File metadata

File hashes

Hashes for novelai_image_mcp-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ce78bdb209cf8fc22eaf4338b29b37530e26399d8d03e7ba81b0a04e08085259
MD5 508c21f69a154d5834e0a26ee0d276a8
BLAKE2b-256 ae2b19e621057c7862e94c9a5ccaa5bcf3791803ae78518a678f2a70323ecd26

See more details on using hashes here.

Provenance

The following attestation bundles were made for novelai_image_mcp-0.1.3-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