resources

The novelai://... resources: the model catalogue, the sampler vocabulary, the active generation defaults and the generated-image template.

See also

Transports for how clients read them

MCP resources exposing the server’s static capability surface.

Resources are read-only context an agent pulls without spending Anlas: the model catalogue, the sampler vocabulary, the active generation defaults, and the generated PNGs themselves. The vocabularies are derived from nai.constants so there is a single source of truth.

novelai_image_mcp.resources.generation_defaults(app=Depends(get_app_context))[source]

Return the active generation defaults (never credentials or endpoints).

Parameters:

app (AppContext)

Return type:

dict[str, Any]

novelai_image_mcp.resources.list_models()[source]

List the supported NovelAI models and their capabilities.

Return type:

dict[str, Any]

novelai_image_mcp.resources.list_samplers()[source]

List the sampler, noise-schedule and UC-preset values the API accepts.

Return type:

dict[str, Any]

novelai_image_mcp.resources.read_output_image(name, app=Depends(get_app_context), routing=Depends(get_routing_context), *, route_scoped_output=Depends(get_route_scoped_output))[source]

Return one generated PNG by filename.

The name must be a plain *.png filename that resolves inside the directory the request’s images were written to: the configured output directory, or its per-route subdirectory when model routing is active and route-scoped output is on. Anything else – a path separator, a traversal, another file type, or a name that only exists outside the scoped directory – is rejected.

Parameters:
Return type:

bytes