Command Palette

Search for a command to run...

UnylyUnyly
Browse all

NovelAI

FreeNot checked

MCP server for NovelAI image generation, supporting V4.5 models with multi-character prompts and multiple transport modes (Stdio, HTTP, SSE) for flexible deploy

GitHubEmbed

About

MCP server for NovelAI image generation, supporting V4.5 models with multi-character prompts and multiple transport modes (Stdio, HTTP, SSE) for flexible deployment.

README

📌 本仓库基于 SGSxingchen/NovelAI_MCP 二次开发,保留了原作者的完整提交历史,感谢原作者的贡献。

💡 搭配推荐:配合 novelai-assistant(面向 AI Agent 的 NovelAI 提示词工程 Skill)使用,AI 可自动将自然语言描述转换为 Danbooru 风格提示词,再交给本 MCP Server 生成图片。

License: MIT TypeScript Node MCP

一个功能完整的 Model Context Protocol (MCP) 服务器,为 NovelAI 图像生成 API 提供支持

English | 简体中文


✨ 特性

  • 🎨 最新模型支持 - 完整支持 NAI Diffusion V4.5 Full
  • 🚀 双传输模式 - Stdio、HTTP SSE、Streamable HTTP
  • 🎭 多角色支持 - V4+ 角色定位和独立提示词系统
  • 📝 中文优化 - 工具描述使用中文,AI 更准确识别调用时机
  • 🔧 灵活部署 - 支持本地运行或 Docker 容器化

📦 快速开始

安装

# 克隆项目
git clone https://github.com/2332239652/NovelAI_MCP.git
cd NovelAI_MCP

# 安装依赖
npm install

# 编译
npm run build

配置

方式一:Stdio 模式(Claude Desktop)

在 Claude Desktop 配置文件中添加:

{
  "mcpServers": {
    "novelai": {
      "command": "node",
      "args": ["项目路径/dist/index.js"],
      "env": {
        "NOVELAI_API_KEY": "your-api-key-here"
      }
    }
  }
}

方式二:Streamable HTTP 模式(LobeChat/Dify 推荐)

Linux/Mac:

export NOVELAI_API_KEY="your-api-key"
export HTTPS_PROXY="http://127.0.0.1:7890"  # 可选:设置代理
npm run start:http

Windows PowerShell:

$env:NOVELAI_API_KEY="your-api-key"
$env:HTTPS_PROXY="http://127.0.0.1:7890"  # 可选:设置代理
npm run start:http

Windows CMD:

set NOVELAI_API_KEY=your-api-key
set HTTPS_PROXY=http://127.0.0.1:7890
npm run start:http

在客户端配置中添加:

  • URL: http://localhost:3000/mcp
  • 传输: Streamable HTTP

方式三:SSE 模式(备选)

Linux/Mac:

export NOVELAI_API_KEY="your-api-key"
export HTTPS_PROXY="http://127.0.0.1:7890"  # 可选
npm run start:sse

Windows PowerShell:

$env:NOVELAI_API_KEY="your-api-key"
$env:HTTPS_PROXY="http://127.0.0.1:7890"
npm run start:sse

Windows CMD:

set NOVELAI_API_KEY=your-api-key
set HTTPS_PROXY=http://127.0.0.1:7890
npm run start:sse

在客户端配置中添加:

  • URL: http://localhost:3000/sse
  • 传输: Server-Sent Events (SSE)

🎯 支持的模型

当前版本专注于最新的 NovelAI V4.5 模型:

模型 说明
nai-diffusion-4-5-full NAI Diffusion V4.5 Full(唯一支持的模型)

🔧 核心参数

参数 类型 说明
base_prompt string 全局场景和风格描述
base_negative_prompt string 全局负面提示词
characters array 角色数组(单人/多人都要用)
width / height number 图片尺寸(必须是 64 的倍数)
steps number 采样步数(锁定 28,免费限制)

完整参数列表请查看 快速参考

📊 传输模式对比

特性 Stdio 模式 Streamable HTTP SSE 模式
适用场景 Claude Desktop LobeChat、Dify(推荐) SSE 客户端
协议标准 MCP Stdio MCP Streamable HTTP MCP SSE Transport
端点 - /mcp /sse + /message
远程访问
多客户端
代理支持
启动命令 npm run start:stdio npm run start:http npm run start:sse

🌍 环境变量

变量 必需 默认值 说明
NOVELAI_API_KEY - NovelAI API 密钥
PORT 3000 HTTP 服务器端口(仅 HTTP 模式)
HTTPS_PROXY - HTTPS 代理地址
HTTP_PROXY - HTTP 代理地址

📚 文档

🛠️ 开发

# 克隆仓库
git clone https://github.com/2332239652/NovelAI_MCP.git
cd NovelAI_MCP

# 安装依赖
npm install

# 编译
npm run build

# 开发模式
npm run dev

# 启动 HTTP 服务器
npm run start:http

🐳 Docker 部署(可选)

项目包含 Dockerfile,可以自行构建:

# 构建镜像
docker build -t novelai-mcp-server .

# 运行容器
docker run -d \
  -p 3000:3000 \
  -e NOVELAI_API_KEY="your-api-key" \
  --name novelai-mcp \
  novelai-mcp-server

🤝 贡献

欢迎提交 Issue 和 Pull Request!

  1. Fork 本项目
  2. 创建特性分支 (git checkout -b feature/AmazingFeature)
  3. 提交更改 (git commit -m 'Add some AmazingFeature')
  4. 推送到分支 (git push origin feature/AmazingFeature)
  5. 开启 Pull Request

📄 许可证

本项目采用 MIT 许可证 - 查看 LICENSE 文件了解详情。

🙏 致谢

🔗 相关链接


如果这个项目对你有帮助,请给个 ⭐️!

from github.com/2332239652/NovelAI_MCP

Install NovelAI in Claude Desktop, Claude Code & Cursor

Recommended · one command, every IDE
unyly install novelai-mcp

Installs into Claude Desktop, Claude Code, Cursor & VS Code — handles npx, uvx and build-from-source repos for you.

First time? Get the CLI: curl -fsSL https://unyly.org/install | sh

Or configure manually

Run in your terminal:

claude mcp add novelai-mcp -- npx -y novelai-mcp-server

Step-by-step: how to install NovelAI

FAQ

Is NovelAI MCP free?

Yes, NovelAI MCP is free — one-click install via Unyly at no cost.

Does NovelAI need an API key?

No, NovelAI runs without API keys or environment variables.

Is NovelAI hosted or self-hosted?

Self-hosted: the server runs locally on your machine via the install command above.

How do I install NovelAI in Claude Desktop, Claude Code or Cursor?

Open NovelAI on unyly.org, pick your client tab (Claude Desktop, Claude Code, Cursor) and press Install — the config is generated automatically, no JSON editing.

Related MCPs

Compare NovelAI with

Not sure what to pick?

Find your stack in 60 seconds

Author?

Embed badge for your README

Browse similar

All media MCPs