API 参考¶
由 autodoc 生成的 novelai_image_mcp 公开 Python API 参考。这些页面通过
内省仓库源码
apps/server/src/novelai_image_mcp/
生成,因此始终反映当前 main 分支的状态。
模块¶
模块 |
说明 |
|---|---|
FastMCP 组合根 + lifespan + 传输方式选择 |
|
|
|
可选的 HTTP bearer-token 认证( |
|
工具调用日志、分路审计与实验性工具门控 |
|
头驱动的路由:route 解析与净化 |
|
|
|
insiders 特性注册表及其解析规则 |
|
Append-only JSONL 审计轨迹:记录结构、脱敏与上限 |
|
两个 prompt 模板 |
|
|
|
结构化输出模型 |
|
|
|
11 个 MCP 工具函数 |
|
NovelAI HTTP 客户端( |
直接使用 API¶
nai/ 子包与 MCP 无关 —— 你可以独立使用它:
import asyncio
import httpx
from novelai_image_mcp.nai import create_novelai_client, GenerationRequest, Action, Model
from novelai_image_mcp.settings import NovelAISettings
async def main():
settings = NovelAISettings(token="pst-...")
async with httpx.AsyncClient(timeout=settings.timeout) as http_client:
client = create_novelai_client(settings, http_client=http_client)
request = GenerationRequest(
prompt="1girl, masterpiece",
action=Action.GENERATE,
model=Model.V4_5,
width=832, height=1216,
)
images = await client.generate(request)
await client.aclose()
asyncio.run(main())
类型检查¶
该 API 带有完整的类型注解,并在标准模式下通过 pyright 检查。IDE
(Pyright、Pylance、mypy)会给出与这些文档中相同的类型信息。