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.0.tar.gz (31.7 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.0-py3-none-any.whl (38.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: novelai_image_mcp-0.1.0.tar.gz
  • Upload date:
  • Size: 31.7 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.0.tar.gz
Algorithm Hash digest
SHA256 236490ae49c8b7527239dc3cb3ca75517ee35337f296511d682f18d322f8044f
MD5 05c5dd25a3d871c1f2b6ff0921afadc2
BLAKE2b-256 a1b817b328cc718492f72594f93e71c61d8722623299e94ae80d0b086de2373a

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for novelai_image_mcp-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a2e698c62110a10bd3c8da7e7d4f9701a74da3e187681693704f162601611eaf
MD5 f0971b7bf9e292deaaa5734ca37928a8
BLAKE2b-256 9dee3c9c00d082dac1303d90a1538c4075757739f466ee2a32a7030318971857

See more details on using hashes here.

Provenance

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