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.1.tar.gz (35.2 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.1-py3-none-any.whl (42.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: novelai_image_mcp-0.1.1.tar.gz
  • Upload date:
  • Size: 35.2 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.1.tar.gz
Algorithm Hash digest
SHA256 9ab01bf655ab29201b39af3bc4c81822b25bcd69e9cc5b4377786dd79717d180
MD5 59e5f2f75e40a869b63d139d7314c673
BLAKE2b-256 f4db7fb2a85d0292b10a00300c99d41721aac1dec6de0a348f2000d2e30d50a7

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for novelai_image_mcp-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 37d6fb4126814dcad06f6a07d4f94de05b5c37662f8edbd7c8aa6631d33d1949
MD5 9d9bd761ab4288b1ffc6c3ba13db5d4b
BLAKE2b-256 a1fad1bb67f0d7c5aa8f85e2c3c4eddf6092720744d5ba1c185c8e617f0838ea

See more details on using hashes here.

Provenance

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