Compare commits

...
26 Commits
Author SHA1 Message Date
novelly-ci af65fd22a9 chore: refresh coverage badge [skip ci] 2026-08-21 18:02:10 +00:00
James Wampler e1df79b31e Update docs and solution file for the stdio MCP server's removal
CI / build-and-push (push) Successful in 47s
CI / deploy (push) Successful in 10s
The prior commit's git add silently dropped these five files because
one path in the same invocation didn't exist. Docs, solution file, and
example config still needed the paired update: Novelly.slnx drops the
Novelly.Mcp project entry, README and CLAUDE.md describe MCP as an
in-API HTTP endpoint instead of a stdio binary, .mcp.json.example uses
the type: http shape, and outline-importer.md's tool references are
fixed to real tool names.
2026-08-21 11:00:25 -07:00
James Wampler 2d6bb9fc57 Delete the stdio MCP server now that the API serves /mcp directly
src/Novelly.Mcp was a separate stdio process, unbuilt by CI, that
looped back over HTTP to the same REST API the previous commit's /mcp
endpoint now calls in-process. Nothing else referenced it (not CI, not
Docker, not the AppHost), so removal is just the project, its solution
entry, and scripts/publish-mcp.sh.

Updates .mcp.json / .mcp.json.example to the type: http form, fixes
.claude/agents/outline-importer.md's already-stale tool references
(list_projects/create_project/etc. never existed; the real names are
list_novels/create_novel/etc.), and rewrites README + CLAUDE.md's
description of the MCP surface and how to verify it at runtime.
2026-08-21 10:59:52 -07:00
James Wampler ab773615f8 Serve the unified tool registry over MCP Streamable HTTP at /mcp
Adds ModelContextProtocol.AspNetCore and registers AddMcpServer with
WithListToolsHandler/WithCallToolHandler rather than 45 attribute
methods, so both handlers resolve the scoped NovelAgentToolset per
request and reuse its hand-built schemas directly instead of fighting
the SDK's delegate-based schema inference.

NovelMcpTools (src/Novelly.Api/Mcp/) is the adapter: it injects a
required novelId property into the advertised schema for tools that
need one and extracts it back out at call time, since the web agent
gets novelId ambiently from its route but an MCP client has no route
to supply it from.

/mcp inherits auth from the existing fallback policy (cookie or
X-Novelly-Api-Key) by adding no authorization metadata of its own —
chaining .RequireAuthorization() would apply the default,
cookie-only policy instead and break the API key. Verified end to end
against a running instance: initialize advertises capabilities.tools,
tools/list returns all 45 with novelId injected only where needed,
tool errors map to result.isError rather than a JSON-RPC error, and a
write (create_tag) round-trips correctly with the service user's
identity intact.
2026-08-21 10:56:24 -07:00
James Wampler 897fb442a1 Unify MCP and agent tool surfaces onto one registry in NovelAgentToolset
Fixes NovelAgentService continuing a conversation under the wrong
novel's route, since FindConversationAsync matched by id alone. Then
extends NovelAgentToolset to all 45 tools the stdio MCP server offered
(tag/location CRUD, character relationships, arc-stage beat pinning,
question editing, cross-novel novel listing/creation), tagging each
with whether it needs an explicit novel scope so a later MCP adapter
can inject it. Renames the toolset's 33 existing schemas from
snake_case to camelCase to match .NET/REST convention, since nothing
external consumes them.

Lays the groundwork to serve this same registry over MCP at /mcp and
retire the separate stdio Novelly.Mcp project (docs/plans/api/mcp_http_merge_plan.md).
2026-08-21 10:52:50 -07:00
James Wampler bb2a499569 Expose Novelly API port + service-key auth for MCP access to QA deploy
CI / build-and-push (push) Successful in 46s
CI / deploy (push) Successful in 9s
MCP server is a stdio process run outside docker, pointed at the API
over HTTP via NOVELLY_API_URL. The api container previously had no
port mapping, so it was unreachable outside the compose network.
2026-08-21 09:42:10 -07:00
novelly-ci 64fff4f1f7 chore: refresh coverage badge [skip ci] 2026-08-21 00:33:01 +00:00
James Wampler 13fa29e8e9 Pin container names in QA compose to match Caddy's upstream hostnames
CI / build-and-push (push) Successful in 53s
CI / deploy (push) Successful in 9s
Caddy reverse-proxies to novelly-web/novelly-api by DNS name, but compose
only registered aliases web/api (service names) plus novelly-web-1/-api-1
(container-number suffixed). Any Caddy restart re-resolves DNS and 502s
until the alias exists again. Pin container_name so the alias is stable
across every redeploy.
2026-08-20 17:32:30 -07:00
James Wampler aca26588f9 Add soft delete + trash, keyboard-first web overhaul, move chapter tags to bottom
CI / build-and-push (push) Failing after 31s
CI / deploy (push) Has been skipped
Adds SoftDelete/Trash across characters, chapters, locations, beats with a
purge schedule and Trash page. Reworks the web client for keyboard-driven
navigation (focus helpers, help overlay, keyboard.md doc). Moves the
ChapterPage tag editor to the bottom of the page to match CharacterDetailPage.
2026-08-20 16:39:09 -07:00
James Wampler 7df1fffdca Tweaks to Import
CI / build-and-push (push) Failing after 37s
CI / deploy (push) Has been skipped
2026-08-20 14:21:44 -07:00
James Wampler 1423977ed4 Modernize web client: dark phase-driven theme, sidebar shell, global agent panel
Replaces the warm-paper/serif look with a dark palette where the novel's
lifecycle phase drives the accent color app-wide. Sidebar nav replaces the
old header/tab-bar. Dashboard leads with quick actions (new chapter, new
character, continue writing) instead of just showing history. Agent chat
is now a context-aware slide-out panel reachable from any page in a novel,
replacing the buried /agent tab.
2026-08-20 14:21:44 -07:00
James Wampler 661f2917ea Add zip upload and mapped-path picker for outline import
Sandbox source paths under a configured Imports:RootPath, browse it
from the web dialog, upload a zip that extracts into staging, and
import a single markdown file (agent infers chapter vs character).
2026-08-20 14:21:44 -07:00
novelly-ci e3d410da0b chore: refresh coverage badge [skip ci] 2026-08-20 01:13:30 +00:00
James Wampler 3795ddd541 Add chapter kind to the web client
CI / build-and-push (push) Successful in 54s
CI / deploy (push) Successful in 9s
Chapter and its cross-referencing chips (tags, locations, questions,
character arcs) now carry kind/displayNumber/label fields end to end.
Chapter detail page gets a Kind selector; chapter chips across the
app render "Foreword"/"Afterword" instead of a misleading number for
front and back matter.
2026-08-19 18:07:21 -07:00
James Wampler 6b0cdd0d71 Surface chapter kind through the MCP server
create_chapter/update_chapter now pass kind through to the API,
matching the FrontMatter/Body/BackMatter option added to the embedded
agent's toolset.
2026-08-19 18:03:18 -07:00
James Wampler 7f56c79b20 Label chapter chips by kind, not raw number
Beats, tags, locations, open questions, and character/arc-stage
responses that reference a chapter now carry a ChapterLabel/DisplayNumber
alongside the raw Number, computed via the new
ChapterDisplayNumberLookup. Front/back matter chips show their title;
body chapters show "Chapter N: Title".
2026-08-19 18:02:53 -07:00
James Wampler ef5260a111 Add ChapterKind for front/back matter chapters
Chapters can now be marked FrontMatter/Body/BackMatter. Number stays
the manuscript sort key for every chapter; the author-facing display
number is now computed per-request as the chapter's ordinal among
Body chapters only, so a foreword or afterword no longer shifts the
numbering of the rest of the book. Surfaced through the API, agent
toolset, and import toolset.
2026-08-19 17:54:20 -07:00
James Wampler 71953220aa Add GitHub-style activity contribution graph
CI / build-and-push (push) Successful in 52s
CI / deploy (push) Successful in 9s
Record create/update/delete events across novel content (chapters, beats,
characters, arc stages, tags, locations, questions) into an append-only
ActivityEvent log, aggregate by UTC day, and surface as a heatmap on the
novels list and each novel's dashboard. Backfills history from existing
CreatedAt timestamps on first boot after the migration.
2026-08-19 17:39:13 -07:00
novelly-ci 51f3176bd0 chore: refresh coverage badge [skip ci] 2026-08-19 22:47:39 +00:00
James Wampler 45afc980d3 Simplify character dossier fields, add ShowPronouns setting
CI / build-and-push (push) Successful in 51s
CI / deploy (push) Successful in 9s
Collapse Want/Need into Motivation and Internal/External Conflict into
Conflict, drop Arc summary field, and move tags below open questions on
the character page. Gate Pronouns display behind new UiSettings:ShowPronouns
config (default off).
2026-08-19 15:33:14 -07:00
James Wampler bbd5e66777 QA deploy: override Agent model to Sonnet 5 (was Opus default)
CI / build-and-push (push) Successful in 45s
CI / deploy (push) Successful in 9s
2026-08-19 15:01:03 -07:00
James Wampler a45e8a59c7 Gate CI to Gitea only for now
CI / build-and-push (push) Successful in 42s
CI / deploy (push) Successful in 9s
GitHub pushes no longer run build/test/coverage at all — the job-level
condition previously only skipped the docker/deploy steps, so every GitHub
push still burned CI minutes on a build+test that went nowhere. GitHub gets
its own release-triggered workflow later.
2026-08-19 14:51:41 -07:00
James Wampler 2d7c2a93b7 fix: bind mount path is /mnt/storage/apps (typo)
CI / build-and-push (push) Successful in 41s
CI / deploy (push) Successful in 9s
2026-08-19 14:48:15 -07:00
James Wampler 304b8b4c59 Switch novelly-data to a bind mount at /mnt/storage/app/novelly/data
CI / build-and-push (push) Successful in 41s
CI / deploy (push) Successful in 8s
Named docker volume replaced with an explicit host path per user request.
Requires the path to exist on the QA server and any data from the old
novelly-data volume to be copied over manually before the next deploy.
2026-08-19 14:46:35 -07:00
James Wampler 8f93dce065 Guard deploys against a broken migration
CI / build-and-push (push) Successful in 46s
CI / deploy (push) Successful in 9s
Program.cs: wrap the boot-time MigrateAsync in try/catch (was an unhandled
exception into a restart:unless-stopped crash-loop), log critical and exit(1)
on failure, and add a --migrate-only flag that applies migrations then exits
0 without starting the web host.

deploy.sh: run migrations as a preflight via the new --migrate-only image
against the live novelly-data volume, before the running (old-image) stack
is touched. A failing migration now aborts the deploy with the old
containers still serving traffic, instead of swapping to a crash-looping
new container first and finding out from the health-check timeout.
2026-08-19 14:23:34 -07:00
James Wampler 7a1c726af8 chore: trigger CI deploy 2026-08-18 19:08:34 -07:00
150 changed files with 11292 additions and 1744 deletions
+5 -5
View File
@@ -1,7 +1,7 @@
--- ---
name: outline-importer name: outline-importer
description: Imports an author's existing novel outline (chapters + character dossiers, in the Kingdom Sleeps folder format) into a Novelly project over the MCP server. Invoke explicitly with a source folder path — this agent does not run proactively. description: Imports an author's existing novel outline (chapters + character dossiers, in the Kingdom Sleeps folder format) into a Novelly project over the MCP server. Invoke explicitly with a source folder path — this agent does not run proactively.
tools: Read, Glob, Grep, Write, mcp__novelly__list_projects, mcp__novelly__get_project_brief, mcp__novelly__create_project, mcp__novelly__update_project_brief, mcp__novelly__list_chapters, mcp__novelly__get_chapter, mcp__novelly__create_chapter, mcp__novelly__update_chapter, mcp__novelly__get_chapter_outline, mcp__novelly__create_beat, mcp__novelly__update_beat, mcp__novelly__list_characters, mcp__novelly__get_character, mcp__novelly__create_character, mcp__novelly__update_character, mcp__novelly__get_character_arc, mcp__novelly__add_arc_stage, mcp__novelly__list_tags tools: Read, Glob, Grep, Write, mcp__novelly__list_novels, mcp__novelly__get_novel_brief, mcp__novelly__create_novel, mcp__novelly__update_novel_brief, mcp__novelly__list_chapters, mcp__novelly__get_chapter, mcp__novelly__create_chapter, mcp__novelly__update_chapter, mcp__novelly__get_chapter_outline, mcp__novelly__create_beat, mcp__novelly__update_beat, mcp__novelly__list_characters, mcp__novelly__get_character, mcp__novelly__create_character, mcp__novelly__update_character, mcp__novelly__get_character_arc, mcp__novelly__add_arc_stage, mcp__novelly__list_tags
model: inherit model: inherit
--- ---
@@ -101,9 +101,9 @@ in your final report.
Do not skip ahead — each pass depends on ids the previous one minted. If you're picking up a Do not skip ahead — each pass depends on ids the previous one minted. If you're picking up a
resumed run, jump straight to the first incomplete pass. resumed run, jump straight to the first incomplete pass.
**0. Preflight.** Call `list_projects` to confirm the API is reachable at all — if this fails, stop **0. Preflight.** Call `list_novels` to confirm the API is reachable at all — if this fails, stop
and tell the user to start the API (`ASPNETCORE_URLS=http://localhost:5080 dotnet run --project src/Novelly.Api`) and tell the user to start the API (`ASPNETCORE_URLS=http://localhost:5080 dotnet run --project src/Novelly.Api`).
and that `.mcp.json` must point at a published `Novelly.Mcp` binary. Glob the source root for Glob the source root for
`outline.md`, `outlines/*.md` or `chapters/*.md`, and `characters/*.md`. If `outline.md` is `outline.md`, `outlines/*.md` or `chapters/*.md`, and `characters/*.md`. If `outline.md` is
missing, stop — that's the one file every pass depends on. Report the file counts found before missing, stop — that's the one file every pass depends on. Report the file counts found before
proceeding. proceeding.
@@ -111,7 +111,7 @@ proceeding.
**1. Project.** Skip if `completedPasses` already has `"project"`. Read `outline.md`. Its heading is **1. Project.** Skip if `completedPasses` already has `"project"`. Read `outline.md`. Its heading is
`# Outline — <Title> (<Author>)` or similar — parse title and author out of it; if there's no `# Outline — <Title> (<Author>)` or similar — parse title and author out of it; if there's no
author, leave it null. The paragraph(s) before the chapter table are the blurb — pass as `notes` author, leave it null. The paragraph(s) before the chapter table are the blurb — pass as `notes`
argument to `create_project` (there's no dedicated blurb field; `synopsis` may be filled in later argument to `create_novel` (there's no dedicated blurb field; `synopsis` may be filled in later
by the author). Record `projectId` in the ledger, mark `"project"` complete. by the author). Record `projectId` in the ledger, mark `"project"` complete.
**2. Characters — dossier fields only, not arcs yet.** Skip files whose name (matched **2. Characters — dossier fields only, not arcs yet.** Skip files whose name (matched
+9 -8
View File
@@ -3,12 +3,10 @@
# scripts/ci/, so the entire pipeline is reproducible by running the same scripts # scripts/ci/, so the entire pipeline is reproducible by running the same scripts
# locally — no marketplace build/test/push actions. # locally — no marketplace build/test/push actions.
# #
# Gitea (origin) is the internal remote and runs the full pipeline: build, test, # Gitea (origin) is the only remote that runs this on push — gated by the
# coverage badge, docker push, deploy, health check. GitHub is the public mirror and
# only needs to prove the code builds and tests pass — it has no registry secrets and
# no [self-hosted, qa] runner, so the docker push/deploy job is skipped there via the
# `github.server_url` check below (identical on both engines: https://github.com on # `github.server_url` check below (identical on both engines: https://github.com on
# GitHub, the Gitea instance URL on Gitea). # GitHub, the Gitea instance URL on Gitea). GitHub pushes intentionally do nothing for
# now; GitHub will get its own release-triggered workflow later.
name: CI name: CI
on: on:
@@ -17,6 +15,7 @@ on:
jobs: jobs:
build-and-push: build-and-push:
if: github.server_url != 'https://github.com'
runs-on: ubuntu-latest runs-on: ubuntu-latest
permissions: permissions:
contents: write contents: write
@@ -43,16 +42,16 @@ jobs:
run: ./scripts/ci/publish-coverage-badge.sh run: ./scripts/ci/publish-coverage-badge.sh
- name: Build Docker images - name: Build Docker images
if: github.server_url != 'https://github.com' && github.ref_name == 'main' if: github.ref_name == 'main'
run: ./scripts/ci/docker-build.sh run: ./scripts/ci/docker-build.sh
- name: Push Docker images - name: Push Docker images
if: github.server_url != 'https://github.com' && github.ref_name == 'main' if: github.ref_name == 'main'
run: ./scripts/ci/docker-push.sh run: ./scripts/ci/docker-push.sh
deploy: deploy:
needs: build-and-push needs: build-and-push
if: github.server_url != 'https://github.com' && github.ref_name == 'main' if: success() && github.ref_name == 'main'
runs-on: [self-hosted, qa] runs-on: [self-hosted, qa]
env: env:
REGISTRY: ${{ secrets.REGISTRY }} REGISTRY: ${{ secrets.REGISTRY }}
@@ -61,6 +60,8 @@ jobs:
REGISTRY_TOKEN: ${{ secrets.REGISTRY_TOKEN }} REGISTRY_TOKEN: ${{ secrets.REGISTRY_TOKEN }}
ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }} ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
WEB_PORT: ${{ vars.WEB_PORT }} WEB_PORT: ${{ vars.WEB_PORT }}
API_PORT: ${{ vars.API_PORT }}
MCP_API_KEY: ${{ secrets.MCP_API_KEY }}
steps: steps:
# actions/checkout@v4 is a Node-based action; this runner has no node in PATH, so # actions/checkout@v4 is a Node-based action; this runner has no node in PATH, so
# checkout plain git instead of via marketplace action. # checkout plain git instead of via marketplace action.
+3
View File
@@ -12,6 +12,9 @@
*.env *.env
.env.deploy .env.deploy
# Local outline drop-box for the import feature (Imports:RootPath)
/imports/
# User-specific files (MonoDevelop/Xamarin Studio) # User-specific files (MonoDevelop/Xamarin Studio)
*.userprefs *.userprefs
+4 -4
View File
@@ -1,10 +1,10 @@
{ {
"mcpServers": { "mcpServers": {
"novelly": { "novelly": {
"command": "./mcp-server/Novelly.Mcp", "type": "http",
"env": { "url": "http://localhost:5080/mcp",
"NOVELLY_API_URL": "http://localhost:5080", "headers": {
"NOVELLY_API_KEY": "<matches the API's Auth:ServiceApiKey user secret>" "X-Novelly-Api-Key": "<matches the API's Auth:ServiceApiKey user secret>"
} }
} }
} }
+7 -6
View File
@@ -8,13 +8,12 @@ Novelly: software plan + write novel. ASP.NET Core 10, C#, TypeScript, React, .N
## Structure ## Structure
- `src/Novelly.Api/` — whole back end, organised by feature. One folder per feature holds - `src/Novelly.Api/` — whole back end, organised by feature, plus the MCP endpoint. One folder
entity, DTOs, service, endpoints together: `Novels/`, `Characters/`, `Chapters/`, `Beats/`, per feature holds entity, DTOs, service, endpoints together: `Novels/`, `Characters/`,
`Scenes/`, `Tags/`, `Agent/`. `Common/` holds what crosses features; `Data/` holds `Chapters/`, `Beats/`, `Scenes/`, `Tags/`, `Agent/`, `Mcp/`. `Common/` holds what crosses
`DbContext` + EF migrations. features; `Data/` holds `DbContext` + EF migrations.
- `src/Novelly.AppHost/` — .NET Aspire orchestration; run this to bring up API + web client - `src/Novelly.AppHost/` — .NET Aspire orchestration; run this to bring up API + web client
- `src/Novelly.ServiceDefaults/` — shared Aspire wiring: OpenTelemetry, health checks, service discovery - `src/Novelly.ServiceDefaults/` — shared Aspire wiring: OpenTelemetry, health checks, service discovery
- `src/Novelly.Mcp/` — MCP stdio server
- `src/Novelly.Web/` — React + Vite client - `src/Novelly.Web/` — React + Vite client
- `tests/` — test suite - `tests/` — test suite
- `docs/` — documentation - `docs/` — documentation
@@ -59,6 +58,7 @@ Serilog console via `AddSerilog` (not `UseSerilog` — keeps OTel provider for A
- `PATCH` requests partial: null field = leave alone, empty string = clear. Keep new update endpoints consistent with `Patch.Apply`. - `PATCH` requests partial: null field = leave alone, empty string = clear. Keep new update endpoints consistent with `Patch.Apply`.
- Enums cross wire as names, never ordinals - Enums cross wire as names, never ordinals
- All frontend components should have an id attribute that identifies them uniquely. - All frontend components should have an id attribute that identifies them uniquely.
- Web client is keyboard-first: read `docs/keyboard.md` before adding any interactive UI (forms, editable rows, create flows).
## Testing ## Testing
@@ -85,7 +85,7 @@ Build + tests passing ≠ working. Anything touching endpoint, agent loop, or MC
Vite dev server on :5173, dashboard for logs + traces Vite dev server on :5173, dashboard for logs + traces
- API alone: `ASPNETCORE_URLS=http://localhost:5080 dotnet run --project src/Novelly.Api`, then exercise route with curl - API alone: `ASPNETCORE_URLS=http://localhost:5080 dotnet run --project src/Novelly.Api`, then exercise route with curl
- Web alone: `cd src/Novelly.Web && npm run dev` — proxies `/api` to :5080 - Web alone: `cd src/Novelly.Web && npm run dev` — proxies `/api` to :5080
- MCP: build it, then drive over stdio JSON-RPC (`initialize``notifications/initialized``tools/list``tools/call`) - MCP: with the API running, drive `/mcp` over HTTP (`initialize``notifications/initialized``tools/list``tools/call`) — Streamable HTTP, so responses are SSE-framed and requests need `Accept: application/json, text/event-stream`
Several real bugs here — SQLite refusing ORDER BY DateTimeOffset, agent's model client throwing at construction + taking read-only endpoints down with it — passed build + test suite, only showed up when app actually ran. Several real bugs here — SQLite refusing ORDER BY DateTimeOffset, agent's model client throwing at construction + taking read-only endpoints down with it — passed build + test suite, only showed up when app actually ran.
@@ -103,5 +103,6 @@ Several real bugs here — SQLite refusing ORDER BY DateTimeOffset, agent's mode
- Anthropic model id lives in `appsettings.json` under `Agent:Model`. Don't hardcode. - Anthropic model id lives in `appsettings.json` under `Agent:Model`. Don't hardcode.
- API key comes from `ANTHROPIC_API_KEY` or `Agent:ApiKey` — never commit one. App must stay fully usable without key; only agent endpoints require it. - API key comes from `ANTHROPIC_API_KEY` or `Agent:ApiKey` — never commit one. App must stay fully usable without key; only agent endpoints require it.
- EF migrations: `dotnet ef migrations add <Name> -p src/Novelly.Api -o Data/Migrations`. API migrates on boot. - EF migrations: `dotnet ef migrations add <Name> -p src/Novelly.Api -o Data/Migrations`. API migrates on boot.
- Outline import root lives in `appsettings.json` under `Imports:RootPath` (`Imports__RootPath` env var). When set, it's the only folder the browse/upload import endpoints and the source picker can reach; unset, those endpoints are disabled and the dialog falls back to a typed path with no sandbox. Created at boot if missing.
- `git push` runs `scripts/ci/prepush.sh` through Husky: build, test, then web build. Run `npm install` - `git push` runs `scripts/ci/prepush.sh` through Husky: build, test, then web build. Run `npm install`
once at repo root to install hook. once at repo root to install hook.
-1
View File
@@ -8,7 +8,6 @@
<Folder Name="/src/"> <Folder Name="/src/">
<Project Path="src/Novelly.Api/Novelly.Api.csproj" /> <Project Path="src/Novelly.Api/Novelly.Api.csproj" />
<Project Path="src/Novelly.AppHost/Novelly.AppHost.csproj" /> <Project Path="src/Novelly.AppHost/Novelly.AppHost.csproj" />
<Project Path="src/Novelly.Mcp/Novelly.Mcp.csproj" />
<Project Path="src/Novelly.ServiceDefaults/Novelly.ServiceDefaults.csproj" /> <Project Path="src/Novelly.ServiceDefaults/Novelly.ServiceDefaults.csproj" />
<Project Path="src/Novelly.Web/Novelly.Web.esproj"> <Project Path="src/Novelly.Web/Novelly.Web.esproj">
<Build /> <Build />
+20 -26
View File
@@ -6,22 +6,21 @@
Software for planning and writing a novel. You outline the book, keep character Software for planning and writing a novel. You outline the book, keep character
dossiers, break chapters into scenes, and draft prose — with a Claude-powered agent dossiers, break chapters into scenes, and draft prose — with a Claude-powered agent
embedded in the app that can read and edit the same data you can, and an MCP server that embedded in the app that can read and edit the same data you can, and an MCP endpoint that
exposes that data to Claude Code, Claude Desktop, or any other MCP client. exposes that same data to Claude Code, Claude Desktop, or any other MCP client.
The point of the three-way arrangement is that there is exactly one source of truth. The The point of the three-way arrangement is that there is exactly one source of truth. The
React UI, the embedded agent, and the MCP server all go through the same REST API, so an React UI's REST calls, the embedded agent, and MCP clients all resolve to the same
edit made from a chat in Claude Code and an edit made by typing in the browser are the application services in-process, so an edit made from a chat in Claude Code and an edit
same edit. made by typing in the browser are the same edit.
## Stack ## Stack
| Piece | Built with | | Piece | Built with |
|---|---| |---|---|
| `Novelly.Api` | ASP.NET Core 10 minimal APIs, EF Core 10 + SQLite, Anthropic SDK, OpenAPI | | `Novelly.Api` | ASP.NET Core 10 minimal APIs, EF Core 10 + SQLite, Anthropic SDK, OpenAPI, MCP over Streamable HTTP (`ModelContextProtocol.AspNetCore`) |
| `Novelly.AppHost` | .NET Aspire orchestration for the API and the web client | | `Novelly.AppHost` | .NET Aspire orchestration for the API and the web client |
| `Novelly.ServiceDefaults` | Shared OpenTelemetry, health checks and service discovery | | `Novelly.ServiceDefaults` | Shared OpenTelemetry, health checks and service discovery |
| `Novelly.Mcp` | MCP stdio server (`ModelContextProtocol`) |
| `Novelly.Web` | React 19, TypeScript, Vite, TanStack Query, Tailwind v4 | | `Novelly.Web` | React 19, TypeScript, Vite, TanStack Query, Tailwind v4 |
The back end is one project organised by feature, not by layer. Each feature folder — The back end is one project organised by feature, not by layer. Each feature folder —
@@ -192,19 +191,10 @@ A few deliberate choices worth knowing about:
## The MCP server ## The MCP server
A stdio MCP server exposing 45 tools over the same REST API. It holds no domain logic of The API itself serves MCP over Streamable HTTP at `POST /mcp`, exposing 45 tools that call
its own — it is a second front end, not a second implementation. the same application services the REST endpoints and the embedded web agent call — it holds
no domain logic of its own, and there's nothing to build or publish separately. The API
Build it, then point your MCP client at the produced binary: process just needs to be running; there's no separate subprocess to keep in sync with it.
```bash
./scripts/publish-mcp.sh
```
Aspire does not run or manage this process — it's a separate stdio subprocess your MCP
client spawns directly, so nothing rebuilds it automatically. Re-run the script (and
reconnect your MCP client) after pulling changes that touch `src/Novelly.Mcp`, or it keeps
serving whatever was published last, including against a stale auth contract.
Copy `.mcp.json.example` to `.mcp.json` (gitignored, since it carries your API key) and Copy `.mcp.json.example` to `.mcp.json` (gitignored, since it carries your API key) and
fill in the key: fill in the key:
@@ -213,10 +203,10 @@ fill in the key:
{ {
"mcpServers": { "mcpServers": {
"novelly": { "novelly": {
"command": "/absolute/path/to/mcp-server/Novelly.Mcp", "type": "http",
"env": { "url": "http://localhost:5080/mcp",
"NOVELLY_API_URL": "http://localhost:5080", "headers": {
"NOVELLY_API_KEY": "<matches the API's Auth:ServiceApiKey user secret>" "X-Novelly-Api-Key": "<matches the API's Auth:ServiceApiKey user secret>"
} }
} }
} }
@@ -225,8 +215,12 @@ fill in the key:
The API must be running, with `Auth:ServiceApiKey` set (e.g. via The API must be running, with `Auth:ServiceApiKey` set (e.g. via
`dotnet user-secrets set Auth:ServiceApiKey <key> -p src/Novelly.Api`) to the same value `dotnet user-secrets set Auth:ServiceApiKey <key> -p src/Novelly.Api`) to the same value
as `NOVELLY_API_KEY` above. If the API is not running, or the key is missing or mismatched, as the `X-Novelly-Api-Key` header above. If the API is not running, or the key is missing or
the tools say so in a message the model can act on rather than failing opaquely. mismatched, the request 401s.
Tool argument names are camelCase, matching the REST API and every other MCP argument name
this project has ever used. `create_novel` called over MCP is owned by the seeded service
user (an Admin), not whichever person is signed into the web app.
### Importing an existing outline ### Importing an existing outline
+1 -1
View File
@@ -123,7 +123,7 @@
<text x="53" y="15" fill="#010101" fill-opacity=".3">Coverage</text> <text x="53" y="15" fill="#010101" fill-opacity=".3">Coverage</text>
<text x="53" y="14" fill="#fff">Coverage</text> <text x="53" y="14" fill="#fff">Coverage</text>
<text class="" x="132.5" y="15" fill="#010101" fill-opacity=".3">65.7%</text><text class="" x="132.5" y="14">65.7%</text> <text class="" x="132.5" y="15" fill="#010101" fill-opacity=".3">66.5%</text><text class="" x="132.5" y="14">66.5%</text>

Before

Width:  |  Height:  |  Size: 6.1 KiB

After

Width:  |  Height:  |  Size: 6.1 KiB

+26 -7
View File
@@ -1,21 +1,29 @@
name: novelly name: novelly
# Persistent LAN deployment, pulled and recreated by CI on every push to main. # Persistent LAN deployment, pulled and recreated by CI on every push to main.
# Unlike a throwaway QA stack, this one keeps its data volume across deploys — `down` # Unlike a throwaway QA stack, this one keeps its data across deploys — `down` is run
# is run without `-v` so the author's novel data survives a redeploy. # without `-v` and /data is a bind mount to /mnt/storage/apps/novelly/data on the host,
# not a docker-managed volume, so the author's novel data survives a redeploy.
services: services:
api: api:
image: ${API_IMAGE}:latest image: ${API_IMAGE}:latest
container_name: novelly-api
restart: unless-stopped restart: unless-stopped
environment: environment:
ConnectionStrings__Novel: "Data Source=/data/novel.db" ConnectionStrings__Novel: "Data Source=/data/novel.db"
Cors__Origins__0: "http://localhost:${WEB_PORT:-6173}" Cors__Origins__0: "http://localhost:${WEB_PORT:-6173}"
ANTHROPIC_API_KEY: ${ANTHROPIC_API_KEY:-} ANTHROPIC_API_KEY: ${ANTHROPIC_API_KEY:-}
Agent__Model: claude-sonnet-5
Agent__Effort: high
Imports__RootPath: /data/imports
Auth__ServiceApiKey: ${MCP_API_KEY:-}
volumes: volumes:
- novelly-data:/data - /mnt/storage/apps/novelly/data:/data
networks: networks:
- novelly - novelly
ports:
- "${API_PORT:-5080}:8080"
healthcheck: healthcheck:
test: ["CMD-SHELL", "curl -fsS http://localhost:8080/api/health || exit 1"] test: ["CMD-SHELL", "curl -fsS http://localhost:8080/api/health || exit 1"]
interval: 10s interval: 10s
@@ -25,6 +33,7 @@ services:
web: web:
image: ${WEB_IMAGE}:latest image: ${WEB_IMAGE}:latest
container_name: novelly-web
restart: unless-stopped restart: unless-stopped
depends_on: depends_on:
api: api:
@@ -34,10 +43,20 @@ services:
ports: ports:
- "${WEB_PORT:-6173}:80" - "${WEB_PORT:-6173}:80"
# Preflight migration check, run by deploy.sh via `--profile tools run --rm migrate`
# against the newly pulled image before the running stack is touched. Excluded from
# `up -d` by the tools profile.
migrate:
image: ${API_IMAGE}:latest
command: ["dotnet", "Novelly.Api.dll", "--migrate-only"]
environment:
ConnectionStrings__Novel: "Data Source=/data/novel.db"
volumes:
- /mnt/storage/apps/novelly/data:/data
networks:
- novelly
profiles: ["tools"]
networks: networks:
novelly: novelly:
name: novelly-net name: novelly-net
volumes:
novelly-data:
name: novelly-data
+60
View File
@@ -0,0 +1,60 @@
# Keyboard conventions
Novelly's web client is built to be driven entirely from the keyboard. New interactive
components should follow these rules so the app stays consistent as it grows.
## Escape cancels or closes — it never destroys already-saved work
In an editor that commits per field (a beat row, a chapter's title), Escape reverts only the
field you're currently in and then closes the editor. Fields you already tabbed past and
committed stay saved — Escape is honest about this, not a full undo. Anywhere a component *can*
offer a true "discard everything" cancel (a create form that hasn't saved anything yet), do
that instead.
## Enter commits a single-line field and advances
Pressing Enter in a single-line field is equivalent to Tab: it commits the field's value and
moves focus to the next field. Shift+Enter moves to the previous field. This is what
`AutoField` (`src/components/ui.tsx`) does by default — reuse it rather than hand-rolling a
text input's key handling.
## mod+Enter commits a multiline field or completes a record
A `<textarea>` needs plain Enter to insert a newline, so multiline fields commit on
`mod+Enter` (Cmd or Ctrl) instead. The same combo, handled at the row/form level, means "I'm
done with this record" — closing a beat row, submitting a question. This mirrors the app's
original convention in `AgentPanel.tsx` (`mod+Enter` sends a message).
## Bare single letters create the primary thing on the page
`n` is the default create-hotkey across the app (new character, new chapter, new location). A
page with a second creatable thing uses a mnemonic instead (`b` for beat, `q` for question, `a`
for arc stage). Register these with `useHotkey` from the component that owns the create action,
so the shortcut is scoped to that page/section and unregisters when it unmounts — never
register a bare letter globally.
## Creating something puts focus in its first editable field
A create action that leaves the user hunting for the thing they just made is a bug. Land focus
in the new item's first field (or, when a mutation's response id isn't the field's DOM node
yet, request focus for that id and let it land once the row/page actually renders — see the
`focusRequestId`/`onAutoFocused` pattern used for beats and arc stages).
## Chip inputs commit on Enter, comma, or blur
`TagEditor`, `LocationEditor`, `CharacterMultiSelect`, and `AliasEditor` all add their draft
value to the list on Enter, comma, or losing focus. Follow the same shape for any new
chip-style input.
## Destructive confirmations use `ConfirmModal`
Never use the native `confirm()`/`alert()` dialogs — they're not stylable, not consistent with
the rest of the app, and (depending on browser) can be genuinely awkward to dismiss from the
keyboard. Use `ConfirmModal` (`src/components/ConfirmModal.tsx`), which wraps `Modal` and gets
focus-trapping and Escape-to-close for free.
## The exception, not the rule: `allowInInputs`
`useHotkey` shortcuts don't fire while a text field is focused, unless registered with
`allowInInputs: true`. Reserve that for shortcuts that make sense mid-typing (`mod+Enter` to
submit, `Escape` to close) — never a bare letter.
+180
View File
@@ -0,0 +1,180 @@
# Merge the MCP server into Novelly.Api as Streamable HTTP `/mcp`
## Context
Novelly has two duplicate tool surfaces that must be kept in sync by hand:
- **`src/Novelly.Mcp/`** — 45 tools as `[McpServerTool]` static methods, stdio-only, each calling the REST API back over HTTP via `NovelApiClient`. Built by no CI job, in no container, unknown to the AppHost. It only works if someone remembers to run `scripts/publish-mcp.sh` and re-point `.mcp.json` at the published binary. Zero tests.
- **`src/Novelly.Api/Agent/NovelAgentToolset.cs`** — 33 tools for the embedded web agent, calling application services directly in-process.
The 33 are a **strict subset** of the 45, matching name-for-name. The gap is pure capability loss for the web agent, not a design distinction.
Two problems follow. The MCP server is unreachable from anything but a local stdio subprocess, so the QA deploy can't serve it without shipping a binary around. And every new capability has to be written twice, in two idioms, with nothing enforcing that they agree.
**Outcome:** one tool registry, called directly by both surfaces. The API serves MCP over Streamable HTTP at `/mcp`, so any MCP client reaches it over the network with an API key and no binary to distribute. The stdio project is deleted. The web agent gains all 12 tools it was missing.
## Decisions taken
- **Delete `src/Novelly.Mcp` entirely.** No stdio proxy is kept.
- **The web agent gets all 45 tools**, including cross-novel `list_novels` and `create_novel`. Full parity, one list, no filtering.
- **camelCase argument names** everywhere. MCP specifies nothing about argument naming — `inputSchema` is plain JSON Schema — so this is a free choice, and camelCase matches .NET convention, the REST API's `JsonSerializerDefaults.Web` output, and the current MCP surface. Existing MCP clients keep working unchanged. The cost lands on `NovelAgentToolset`'s 33 hand-built schemas, which are today the only snake_case thing in the repo and must be rewritten.
- **Tool names stay snake_case** (`list_novels`, `get_novel_brief`) — that part *is* genuine MCP convention, and both surfaces already agree on it.
## Design
A single registry — the existing `AgentTool` shape in `NovelAgentToolset`, extended to all 45 tools — with two thin adapters over it.
**MCP adapter.** Register the SDK's dynamic-tools handlers rather than 45 attribute-decorated methods:
```csharp
services.AddMcpServer(o => o.ServerInfo = new Implementation { Name = "novelly", Version = "1.0.0" })
.WithHttpTransport()
.WithListToolsHandler((request, ct) => ...)
.WithCallToolHandler((request, ct) => ...);
```
Both handlers resolve `request.Services!.GetRequiredService<NovelAgentToolset>()` per request and delegate to a pure adapter class. This avoids fighting the SDK's schema inference (`McpServerToolCreateOptions` has no `InputSchema` property) and avoids hoisting the scoped, nine-dependency toolset into a static catalog, which `WithTools(IEnumerable<McpServerTool>)` would force.
**Agent adapter.** Unchanged — `NovelAgentService.SendMessageAsync``toolset.ExecuteAsync(name, novelId, input, ct)`, with `novelId` still ambient from the route and never shown to the model.
**Novel scoping, one entry / two shapes.** `AgentTool` and `AgentToolDefinition` each gain a trailing `bool RequiresNovelId = false`, so the 33 existing construction sites keep compiling. The MCP adapter injects a required `novelId` property into the advertised schema for those tools and extracts it at call time; the agent adapter supplies it from the route. `list_novels` / `create_novel` need no scope at all.
The 11 currently novel-scoped tools are identifiable mechanically — `grep -n 'async (novelId' src/Novelly.Api/Agent/NovelAgentToolset.cs`: `get_novel_brief`, `update_novel_brief`, `list_characters`, `create_character`, `list_tags`, `list_locations`, `list_chapters`, `create_chapter`, `get_character_beats`, `list_open_questions`, `raise_open_question`. Of the 12 new tools, `create_tag` and `create_location` are novel-scoped; the other ten are child-id-scoped or unscoped.
### Verified before planning
The design rests on SDK behaviour that build-and-test would not catch, so it was checked against a running probe app rather than inferred from docs:
- `WithListToolsHandler` / `WithCallToolHandler` exist in `ModelContextProtocol` 2.1.0; `Tool.InputSchema` is a settable `JsonElement` whose setter validates exactly what `JsonSchemaBuilder.Build()` already emits.
- **`capabilities.tools` *is* advertised** on `initialize` with handlers and no `ToolCollection` — this was the main open risk and it is closed.
- **`request.Services` is non-null and yields a fresh DI scope per request** (three calls returned three distinct scope ids). This is what makes the scoped `NovelDbContext` and `NovelAgentToolset` correct here. `HttpServerTransportOptions.Stateless` defaults to `true` and `PerSessionExecutionContext` to `false` in 2.1.0, so no options need restating.
- A hand-built `JsonElement` schema survives verbatim onto `tools/list` output, and `IsError` maps to `result.isError` rather than a JSON-RPC error object.
- `GET /mcp` returns 405 in stateless mode. Harmless; clients only POST.
## Chunks
Each builds, tests and commits independently.
### Chunk 0 — Fix the cross-novel conversation leak
Independent; do it first to keep it out of the main diff.
`NovelAgentService.FindConversationAsync(Guid conversationId, ...)` matches on id alone, so a conversation belonging to novel X can be continued under novel Y's route, after which every tool call runs against Y with X's transcript. Add an optional novel filter, passed from `SendMessageAsync` only — `GetConversationAsync`/`DeleteConversationAsync` are reached via `/api/conversations/{id}`, which has no novel in the route, and keep passing `null`. Log the miss at Warning with `{ConversationId}`/`{NovelId}`.
**Files:** `src/Novelly.Api/Agent/NovelAgentService.cs`, `tests/Novelly.Api.Tests/NovelAgentServiceTests.cs`
**Tests:** `Continuing_a_conversation_under_a_different_novel_is_rejected`, plus `Continuing_a_conversation_under_its_own_novel_still_works` as the guard against over-tightening.
### Chunk 1 — One registry, all 45 tools (no MCP wiring yet)
Delivers the parity decision on its own, verifiable through the existing web agent.
- `src/Novelly.Api/Agent/AgentContracts.cs` — add `RequiresNovelId` to `AgentToolDefinition`. Safe: `AnthropicAgentModelClient.ToSdkTool` maps `Name`/`Description`/`InputSchema` explicitly, so the flag never reaches the model.
- `src/Novelly.Api/Agent/NovelAgentToolset.cs` — add `RequiresNovelId` to `AgentTool`, set it on the 11 tools above, flow it into `Definitions`, and add the 12 new tools reusing the existing `OrNotFound` / `DeletedOrNotFound` / `ToolNotFound` idioms and the descriptions from the corresponding `src/Novelly.Mcp/Tools/*.cs` methods.
- **Rename the 33 existing schemas to camelCase** in the same file — both the `JsonSchemaBuilder` property keys and the matching `JsonInput` lookup strings, which must stay in lockstep (`.Str("character_id", …)` / `JsonInput.RequiredGuid(input, "character_id")``"characterId"`). Mechanical and contained to this one file, but it is the bulk of the chunk's diff and a mismatched pair fails silently as a missing argument rather than a compile error — so the per-tool tests below are what actually catch it. The 12 new tools are written camelCase from the start, matching the names their `src/Novelly.Mcp/Tools/*.cs` equivalents already used.
The 12 new tools and their existing service calls — no service-layer work is needed:
| tool | scope | service call |
|---|---|---|
| `list_novels` | none | `novels.ListAsync` |
| `create_novel` | none | `novels.CreateAsync` |
| `get_character` | child | `characters.GetAsync` |
| `relate_characters` | child | `characters.AddRelationshipAsync` — note `CreateRelationshipRequest`'s parameter order differs from the old MCP method's |
| `set_arc_stage_beats` | child | `arcs.SetBeatsAsync` |
| `create_tag` | **novel** | `tags.CreateAsync` |
| `update_tag` / `delete_tag` | child | `tags.UpdateAsync` / `DeleteAsync` |
| `create_location` | **novel** | `locations.CreateAsync` |
| `update_location` / `delete_location` | child | `locations.UpdateAsync` / `DeleteAsync` |
| `update_open_question` | child | `questions.UpdateAsync` |
Guid-list arguments follow the existing `JsonInput.Guids` idiom used by `reorder_beats`.
**Tests:** new `tests/Novelly.Api.Tests/NovelAgentToolsetTests.cs`, driving `ExecuteAsync` directly in the style of `ImportAgentToolsetTests.cs` (`ServiceTestFixture` already wires every service the toolset needs). BDD names, one per new capability — e.g. `Relating_two_characters_shows_the_pair_on_both_dossiers`, `Deleting_a_tag_leaves_the_characters_that_carried_it_alone`, `Updating_an_open_question_can_detach_it_from_its_chapter`. Two structural tests carry the most weight:
- `The_toolset_offers_every_tool_the_stdio_server_offered` — assert the 45 names against a hard-coded array. This is the anti-drift test.
- Assert no `RequiresNovelId` tool's schema already declares `novelId`, since the MCP adapter injects it and a duplicate would be silent.
**Runtime verify:** AppHost up, open a novel's agent panel, ask it to create a tag and list tags; confirm in the Aspire trace.
### Chunk 2 — Serve the registry at `/mcp`
- `src/Novelly.Api/Novelly.Api.csproj` — add `ModelContextProtocol.AspNetCore` 2.1.0 (brings Core transitively; don't reference it directly). **Not in the local NuGet cache — first restore needs network.** Pin 2.1.0 to match the verified surface.
- New feature folder `src/Novelly.Api/Mcp/`:
- `NovelMcpTools.cs` — the adapter, as pure static methods: `Describe(definitions)` maps to `Tool` records, injecting `novelId` where `RequiresNovelId`; `CallAsync(toolset, parameters, ct)` serializes arguments to a `JsonElement`, extracts `novelId` when required (`Guid.Empty` otherwise), calls `ExecuteAsync`, and maps `AgentToolResult``CallToolResult`. Catch the `ArgumentException` from a missing/malformed `novelId` and return it as `IsError` rather than letting it escape as a JSON-RPC error. **Log `{Tool}` and `{NovelId}` only — never the arguments, which carry prose (`what_happened`, `synopsis`, `notes`).**
- `McpEndpoints.cs``MapNovelMcp()` calling `app.MapMcp("/mcp")`, matching the repo's `Map*Endpoints` convention.
- `src/Novelly.Api/Common/NovellyServiceRegistration.cs` — the `AddMcpServer(...)` registration shown above.
- `src/Novelly.Api/Program.cs``.MapNovelMcp()` after `UseAuthentication()`/`UseAuthorization()`.
**Auth — the trap.** Do **not** chain `.RequireAuthorization()` onto `MapMcp`. The parameterless overload applies the *default* policy, which authenticates `IdentityConstants.ApplicationScheme` only and would reject the API key. The fallback policy already registered in `NovellyServiceRegistration` lists both that scheme *and* `ServiceApiKeyAuthenticationHandler.SchemeName`, and applies to any endpoint carrying no authorization metadata — which `MapMcp` adds none of. `/mcp` inherits the right protection by doing nothing. If explicitness is wanted, register a named policy listing both schemes; never the parameterless call.
External clients send `X-Novelly-Api-Key: <Auth:ServiceApiKey>`, resolving to `ServiceUser` (Admin), which sees every novel. If `Auth:ServiceApiKey` is unset the service user is never seeded and every call 401s.
CORS needs no change — the origin-restricted default policy is irrelevant to non-browser clients, and stateless mode exposes no `Mcp-Session-Id` header to read.
**Tests:** new `tests/Novelly.Api.Tests/NovelMcpToolsTests.cs`, against the pure adapter methods — no live session, no `WebApplicationFactory`. Cover: all 45 advertised with unique names; novel-scoped tools declare a required `novelId` and child-id tools don't; `list_novels` needs none; every advertised schema is a valid `type: object` (what `Tool.InputSchema`'s setter enforces, worth asserting before the SDK throws at startup); a missing `novelId` and a not-found id both come back as `IsError` results.
**Deliberately not adding a `WebApplicationFactory` harness.** None exists in the repo; adding one means an MVC.Testing reference, overriding the connection string, working around `Program.cs`'s boot-time `MigrateAsync` + `Environment.Exit(1)`, seeding the key, and parsing SSE. Its main payoff — proving the SDK wires up — is delivered more honestly by the curl walkthrough below, which exercises real Kestrel including auth, Serilog and the exception handler. Worth a separate chunk later if a regression harness is wanted.
### Chunk 3 — Delete the stdio server
Only after Chunk 2 is verified, so there's never a window with no MCP surface.
Remove `src/Novelly.Mcp/`, `scripts/publish-mcp.sh`, the `mcp-server/` publish output (gitignored; working-tree cleanup only), and the project line in `Novelly.slnx`. Verified as *not* referencing it: `scripts/ci/build.sh` (publishes the API by path), `prepush.sh`, `test.sh`, both Dockerfiles, the AppHost.
Docs to update:
- `README.md` — fold the `Novelly.Mcp` stack-table row into the API's; rewrite "The MCP server" section (same 45 tools, now in-process at `POST /mcp`, no build step, `X-Novelly-Api-Key` auth). Note that MCP argument names are unchanged (camelCase), so existing clients need no edits, and that `create_novel` is owned by the signed-in user over the web agent but by the service user over MCP.
- `.mcp.json` / `.mcp.json.example` — switch to `type: "http"`, `url: http://localhost:5080/mcp`, with the key in `headers`.
- `.claude/agents/outline-importer.md` — drop the published-binary requirement. Its `tools:` frontmatter is **already stale** (`mcp__novelly__list_projects`, `get_project_brief`, `create_project` exist in neither surface); fix to real names while here.
- `CLAUDE.md` — the Structure list still calls `src/Novelly.Mcp/` the "MCP stdio server" and Verifying still says "drive over stdio JSON-RPC". Propose these edits rather than slipping them in; CLAUDE.md is user-owned.
Leave `docs/plans/api/users_and_roles_plan.md` alone — historical.
**Verify:** `dotnet build Novelly.slnx` and `./scripts/ci/prepush.sh` both pass.
## Verification
Streamable HTTP needs `Accept: application/json, text/event-stream` and replies SSE-framed, so pipe through `sed -n 's/^data: //p'`.
```bash
dotnet user-secrets set Auth:ServiceApiKey devkey -p src/Novelly.Api
ASPNETCORE_URLS=http://localhost:5080 dotnet run --project src/Novelly.Api
MCP=http://localhost:5080/mcp
H=(-H "Content-Type: application/json" -H "Accept: application/json, text/event-stream" -H "X-Novelly-Api-Key: devkey")
# handshake — expect capabilities.tools present
curl -sS "${H[@]}" "$MCP" -d '{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2025-06-18","capabilities":{},"clientInfo":{"name":"curl","version":"1"}}}' | sed -n 's/^data: //p' | jq .
curl -sS "${H[@]}" -o /dev/null -w '%{http_code}\n' "$MCP" -d '{"jsonrpc":"2.0","method":"notifications/initialized"}'
# expect exactly 45
curl -sS "${H[@]}" "$MCP" -d '{"jsonrpc":"2.0","id":2,"method":"tools/list","params":{}}' | sed -n 's/^data: //p' | jq '.result.tools | length'
# novelId injection: present on list_tags, absent on delete_tag and list_novels
curl -sS "${H[@]}" "$MCP" -d '{"jsonrpc":"2.0","id":3,"method":"tools/list","params":{}}' | sed -n 's/^data: //p' \
| jq '.result.tools[] | select(.name=="list_tags" or .name=="delete_tag" or .name=="list_novels") | {name, props:(.inputSchema.properties|keys), required:.inputSchema.required}'
# unscoped call, then a novel-scoped one (proves NovelUserContext resolved the service user in-handler)
curl -sS "${H[@]}" "$MCP" -d '{"jsonrpc":"2.0","id":4,"method":"tools/call","params":{"name":"list_novels","arguments":{}}}' | sed -n 's/^data: //p' | jq .
curl -sS "${H[@]}" "$MCP" -d '{"jsonrpc":"2.0","id":5,"method":"tools/call","params":{"name":"get_novel_brief","arguments":{"novelId":"<id from above>"}}}' | sed -n 's/^data: //p' | jq .
# error mapping — expect result.isError true, not a JSON-RPC error
curl -sS "${H[@]}" "$MCP" -d '{"jsonrpc":"2.0","id":6,"method":"tools/call","params":{"name":"list_tags","arguments":{}}}' | sed -n 's/^data: //p' | jq .
# auth — expect 401 with no key
curl -sS -o /dev/null -w '%{http_code}\n' -H "Content-Type: application/json" -H "Accept: application/json, text/event-stream" \
"$MCP" -d '{"jsonrpc":"2.0","id":7,"method":"tools/list","params":{}}'
# one write, end to end
curl -sS "${H[@]}" "$MCP" -d '{"jsonrpc":"2.0","id":8,"method":"tools/call","params":{"name":"create_tag","arguments":{"novelId":"<id>","name":"Salt","color":"#9a4a2f"}}}' | sed -n 's/^data: //p' | jq .
```
Then reconnect a real client: rewrite `.mcp.json` to the `type: "http"` form and run `/mcp` in Claude Code to confirm 45 tools. Finally confirm the web agent still drives the same registry (Aspire up, agent panel, exercise one of the 12 new tools) and that the dashboard shows `/mcp` requests with no prose in the log lines.
## Risks
- **`ModelContextProtocol.AspNetCore` is not cached locally.** First restore needs network.
- **The web agent's argument names change** (snake_case → camelCase) across all 33 existing tools. Nothing external consumes those schemas — they are built fresh per request and handed to the model each turn — so there is no compatibility surface, but a `JsonSchemaBuilder` key left out of step with its `JsonInput` lookup fails silently as a missing argument rather than a compile error. External MCP clients are unaffected: their argument names were already camelCase.
- **`create_novel` ownership differs by surface** — signed-in user vs service user. Not a bug, but surprising; document it.
- **Not fixed here:** child-id-scoped tools carry no novel context in *either* surface, so a caller holding a foreign beat/tag/question id can reach across novels, subject only to `NovelAccessService`. Pre-existing for 20+ tools and unchanged by this work. Worth a follow-up.
- **QA deploy:** once merged, `/mcp` rides the existing API container and its already-exposed port. `MCP_API_KEY` must be set in Gitea for `Auth__ServiceApiKey`, or every MCP call 401s.
@@ -0,0 +1,48 @@
# Frontend Modernization — Output
Implemented per `docs/plans/web/frontend-modernization_plan.md`, all 5 chunks.
## Chunk 1 — Design tokens + primitives
- `src/index.css`: full token rewrite. Dark-first palette (`--canvas`, `--surface`, `--surface-sunken`, `--ink`, `--ink-muted`, `--line`), violet `--accent` default, light-mode override via `prefers-color-scheme` + `data-theme`.
- Five-stage color ramp `--stage-1..5` (violet → blue → coral → teal → gold), shared by `NovelPhase` and `DraftStatus` via `src/api/stage.ts` (`novelPhaseColor`, `draftStatusColor`) — both are 5-step progressions, one hue system backs both.
- Fonts self-hosted via `@fontsource-variable/*` (no CDN dep): Fraunces (display), Inter (UI), Source Serif 4 (prose/markdown), JetBrains Mono (utility). Imported in `src/main.tsx`.
- `src/components/ui.tsx` primitives (`.card`, `.btn`, `.input`, `StatusBadge`, etc.) rebuilt on the new tokens.
## Chunk 2 — Sidebar shell
- `src/pages/NovelLayout.tsx` rebuilt: left sidebar (wordmark, novel title, phase pill, icon nav) replaces the old header + horizontal tab bar. Kills the old back-link-next-to-title layout — top bar is now just a breadcrumb.
- New `src/components/icons.tsx` — small hand-written inline SVG icon set (no icon library dependency).
- **Signature element**: novel's `phase` sets `--accent`/`--accent-soft` for the whole layout, scoped via inline style on the layout root. Nav active state, buttons, focus rings, phase pill all recolor together when phase changes.
- Bug fixed during build: breadcrumb section-matching used a suffix `startsWith` check that broke on exact segment matches (`chapters` vs `chapters/`) — replaced with explicit segment split/compare.
## Chunk 3 — Dashboard rebuild
- `src/pages/DashboardPage.tsx`: quick-actions row now leads the page — **New chapter** (creates + jumps into the editor), **New character** (reuses the add-character modal, now exported from `CharactersPage.tsx`), and **Continue writing** (jumps to the most-recently-updated chapter, or **View chapters** if nothing's drafted).
- Brainstorming phase gets its own pair above the notes field: **Add a character** / **Move to outlining**.
- Renamed `OutliningDashboard``WorkDashboard` (it covers Outlining/Writing/Editing/Complete, not just Outlining — old name was misleading).
- History content (activity graph, recent chapters/characters, tag cloud) unchanged, just repositioned under the new hero row.
## Chunk 4 — Global agent panel
- `/agent` route and `pages/AgentPage.tsx` retired.
- New `src/components/AgentPanel.tsx`: fixed slide-out drawer mounted in `NovelLayout` (shell level), reachable from every page in a novel via the sidebar "Agent" toggle or `g a`. Non-modal — background stays interactive.
- **Context-aware**: panel shows "Talking about {X}" — resolves to the specific chapter/character title on detail pages, falls back to section name elsewhere. Each outgoing message gets a `Context: {label}` line prepended (server has no route awareness, so this is how the agent learns what page you're on); stripped back out and shown as a small "re: …" tag on render rather than raw text in the transcript.
- Compacted the old two-pane (sidebar list + chat) layout into a single column with a conversation-switcher dropdown — panel width doesn't fit a full list rail.
- No backend changes — works within the existing `SendAgentMessageRequest` shape.
## Chunk 5 — Polish
- Global `:focus-visible` ring via `box-shadow` (not `outline`, to avoid clobbering `TagColorPicker`'s outline-based selection indicator or `.input`'s own focus ring). Ring color follows the phase accent.
- Global `prefers-reduced-motion: reduce` override (`!important` on `animation-duration`/`transition-duration`/`scroll-behavior`) — neutralizes the agent panel's slide transition too, since author `!important` beats a normal-priority inline style in the cascade.
- Fixed two leftover hardcoded `#9a4a2f` (old terracotta accent) defaults in `TagColorPicker.tsx` and `TagsPage.tsx` → new violet `#7c5cff`.
- Audited remaining pages (Settings, Locations, Tags, Characters, Chapters) — all inherit cleanly from the chunk-1 primitives already, no stale styling found.
## Verification
Every chunk built clean (`npm run build`) and was clicked through live in Chrome against a local API + SQLite instance — login/signup, novel creation, phase switching (confirmed accent recolor live: violet → blue → coral), chapter/character creation flows, agent panel open/close/context-swap across navigation, keyboard focus ring.
## Deferred / not done
- Sidebar collapse toggle — mentioned in the original plan's layout description ("persistent, icon+label, collapsible") but never implemented; flagged as deferred in chunk 2 and again in chunk 5. Would need its own pass (collapsed-width icon rail, persisted preference).
- No backend/API changes anywhere in this arc — all five chunks were frontend-only.
@@ -0,0 +1,41 @@
# Frontend Modernization Plan
## Design direction
Drop warm-paper/serif "manuscript" look — reads dated, low-contrast, single dull accent. New identity: **phase-driven color**. Novelly already models a novel's lifecycle as phases (`Brainstorming → Outlining → Drafting → Revising → Final`, see `novelPhases`, `StatusBadge` tones). Make that real data drive the whole app's mood instead of hiding in a badge — the active novel's phase sets an accent hue across nav, buttons, focus rings, charts. Writer sees at a glance "I'm in draft mode" vs "polishing." Distinctive, grounded in the product's own model, not decoration.
### Tokens
Color (base neutrals, dark-first):
- `--ink: #14121a` / `--ink-muted: #8b859a`
- `--surface: #1b1825` (panel/card) / `--surface-sunken: #100e17`
- `--canvas: #0c0a12` (app background)
- `--line: #2c2838`
- Light mode mirrors with `--canvas:#f7f6fb`, `--surface:#ffffff`, `--ink:#14121a`
Phase accents (used for `--accent` + `--accent-soft`, swapped by `novel.phase`):
- Brainstorming — `#7c5cff` violet
- Outlining — `#2f8fe0` blue
- Drafting — `#ff7a45` coral
- Revising — `#14b88a` teal
- Final — `#d9a404` gold
Type:
- Display (headlines, dashboard hero, page titles): **Fraunces** — variable serif w/ real character, used large/sparingly
- UI (nav, buttons, body chrome): **Inter**
- Prose editing (chapter/beat text, agent transcript): keep a serif for long-form reading — **Source Serif 4** replaces Iowan/Palatino (renders consistently, not Mac-only)
- Utility/data (counts, timestamps, mono bits): **JetBrains Mono**
Layout: left sidebar nav (persistent, icon+label, collapsible), agent as a right-docked slide-out panel triggered from anywhere (sidebar icon, always visible), main content full-bleed under a slim top bar (breadcrumb + phase pill + user menu — no more "← Novels" link floating left of the title).
Signature element: the phase-accent system itself — nav active states, primary buttons, focus rings, and the dashboard's activity graph all recolor together when phase changes. Nothing else in the app competes for boldness; everything else stays a disciplined dark neutral.
## Chunks (each independently buildable/committable)
1. **Design tokens + primitives** — rewrite `index.css` theme (colors, fonts incl. `@font-face`/Google Fonts imports, spacing), update `ui.tsx` primitives (`btn`, `card`, `input`, `StatusBadge`) to new tokens. No layout changes yet — existing pages just reskin. Fastest way to see the new palette/type everywhere at once.
2. **App shell: sidebar nav** — replace `NovelLayout`'s header+tab-bar with left sidebar (novel switcher, section nav, phase pill), slim top bar. Fixes the back-link-left-of-title complaint structurally. Agent gets a nav icon but no panel yet (still routes to `/agent` page).
3. **Dashboard rebuild** — make it the true home: recent activity + work history (already there) alongside prominent "start new work" actions (new chapter, new character, continue last chapter) above the fold. This is the biggest content/layout change, isolated to one page.
4. **Global agent panel** — extract `AgentPage`'s chat UI into a slide-out panel mounted at the app shell level (outside `<Outlet>`), triggered from the sidebar on any route, passes current route/entity as context. Retire the standalone `/agent` route once panel covers it.
5. **Polish pass** — motion (panel slide, nav active-state transitions, dashboard load-in), empty states, focus-visible/reduced-motion audit, remaining pages (Characters/Chapters/Tags/Locations/Settings) get spacing/type touch-ups to match new primitives from chunk 1.
Suggest reviewing after each chunk before starting the next — chunk 2 and 4 both touch navigation/shell so seeing 12 landed first will make it obvious if the sidebar direction is right before the agent panel builds on top of it.
+11
View File
@@ -13,12 +13,23 @@ registry_login
export API_IMAGE WEB_IMAGE export API_IMAGE WEB_IMAGE
export ANTHROPIC_API_KEY="${ANTHROPIC_API_KEY:-}" export ANTHROPIC_API_KEY="${ANTHROPIC_API_KEY:-}"
export WEB_PORT="${WEB_PORT:-6173}" export WEB_PORT="${WEB_PORT:-6173}"
export API_PORT="${API_PORT:-5080}"
export MCP_API_KEY="${MCP_API_KEY:-}"
COMPOSE="docker compose -f deploy/qa/docker-compose.qa.yml" COMPOSE="docker compose -f deploy/qa/docker-compose.qa.yml"
log "Pulling latest :latest images" log "Pulling latest :latest images"
$COMPOSE pull $COMPOSE pull
# Applies pending migrations against the live novelly-data volume using the new image,
# before the running (old-image) stack is touched. If a migration is broken, this fails
# here and the old containers keep serving traffic — `down`/`up` below never runs, so
# there is nothing to roll back.
log "Running preflight migration check"
if ! $COMPOSE --profile tools run --rm migrate; then
fail "migration failed against the new image; old novelly stack left running untouched"
fi
log "Recreating the novelly stack (data volume preserved)" log "Recreating the novelly stack (data volume preserved)"
$COMPOSE down $COMPOSE down
$COMPOSE up -d $COMPOSE up -d
-15
View File
@@ -1,15 +0,0 @@
#!/usr/bin/env bash
# Rebuilds the standalone Novelly.Mcp binary that Claude Code (or Claude Desktop) spawns
# per .mcp.json. Aspire does not run or manage this process, so nothing else rebuilds it —
# run this after pulling changes that touch src/Novelly.Mcp, or the MCP server silently
# keeps serving whatever was published last.
set -euo pipefail
cd "$(dirname "${BASH_SOURCE[0]}")/.." && source ./scripts/ci/lib.sh
cd "$CI_ROOT"
ensure_dotnet
log "Publishing Novelly.Mcp to ./mcp-server"
dotnet publish src/Novelly.Mcp -c Release -o ./mcp-server
log "Done. Reconnect the MCP server (e.g. /mcp in Claude Code) to pick up the new build."
@@ -0,0 +1,66 @@
using Microsoft.EntityFrameworkCore;
using Novelly.Api.Data;
namespace Novelly.Api.Activity;
public static class ActivityBackfill
{
public static async Task RunAsync(INovelDbContext db, ILogger logger, CancellationToken ct = default)
{
if (await db.ActivityEvents.AnyAsync(ct))
{
return;
}
logger.LogInformation("Backfilling activity events from existing rows");
var events = new List<ActivityEvent>();
var novels = await db.Novels.AsNoTracking().Select(n => new { n.Id, n.CreatedAt }).ToListAsync(ct);
events.AddRange(novels.Select(n => Backfilled(n.Id, ActivityEntityKind.Novel, n.Id, n.CreatedAt)));
var chapters = await db.Chapters.AsNoTracking().Select(c => new { c.Id, c.NovelId, c.CreatedAt, c.WordCount }).ToListAsync(ct);
events.AddRange(chapters.Select(c => Backfilled(c.NovelId, ActivityEntityKind.Chapter, c.Id, c.CreatedAt, c.WordCount)));
var characters = await db.Characters.AsNoTracking().Select(c => new { c.Id, c.NovelId, c.CreatedAt }).ToListAsync(ct);
events.AddRange(characters.Select(c => Backfilled(c.NovelId, ActivityEntityKind.Character, c.Id, c.CreatedAt)));
var arcStages = await db.CharacterArcStages.AsNoTracking().Select(s => new { s.Id, s.CreatedAt, NovelId = s.Character!.NovelId }).ToListAsync(ct);
events.AddRange(arcStages.Select(s => Backfilled(s.NovelId, ActivityEntityKind.ArcStage, s.Id, s.CreatedAt)));
var beats = await db.Beats.AsNoTracking().Select(b => new { b.Id, b.CreatedAt, NovelId = b.Chapter!.NovelId }).ToListAsync(ct);
events.AddRange(beats.Select(b => Backfilled(b.NovelId, ActivityEntityKind.Beat, b.Id, b.CreatedAt)));
var tags = await db.Tags.AsNoTracking().Select(t => new { t.Id, t.NovelId, t.CreatedAt }).ToListAsync(ct);
events.AddRange(tags.Select(t => Backfilled(t.NovelId, ActivityEntityKind.Tag, t.Id, t.CreatedAt)));
var locations = await db.Locations.AsNoTracking().Select(l => new { l.Id, l.NovelId, l.CreatedAt }).ToListAsync(ct);
events.AddRange(locations.Select(l => Backfilled(l.NovelId, ActivityEntityKind.Location, l.Id, l.CreatedAt)));
var questions = await db.OpenQuestions.AsNoTracking().Select(q => new { q.Id, q.NovelId, q.CreatedAt }).ToListAsync(ct);
events.AddRange(questions.Select(q => Backfilled(q.NovelId, ActivityEntityKind.Question, q.Id, q.CreatedAt)));
if (events.Count == 0)
{
return;
}
db.ActivityEvents.AddRange(events);
await db.SaveChangesAsync(ct);
logger.LogInformation("Backfilled {Count} activity events", events.Count);
}
private static ActivityEvent Backfilled(Guid novelId, ActivityEntityKind kind, Guid entityId, DateTimeOffset occurredAt, int wordDelta = 0) =>
new()
{
NovelId = novelId,
UserId = null,
OccurredAt = occurredAt,
DayKey = ActivityDayKey.For(occurredAt),
EntityKind = kind,
Action = ActivityAction.Created,
EntityId = entityId,
WordDelta = wordDelta
};
}
@@ -0,0 +1,5 @@
namespace Novelly.Api.Activity;
public record ActivityDayResponse(DateOnly Date, int Words, int Edits);
public record ActivityCalendarResponse(DateOnly From, DateOnly To, int TotalWords, int TotalEdits, IReadOnlyList<ActivityDayResponse> Days);
@@ -0,0 +1,28 @@
using Novelly.Api.Common;
using Novelly.Api.Common.Validation;
namespace Novelly.Api.Activity;
public static class ActivityEndpoints
{
public static IEndpointRouteBuilder MapActivityEndpoints(this IEndpointRouteBuilder app)
{
var novelScoped = app.MapGroup("/api/novels/{novelId:guid}/activity").WithTags("Activity")
.AddEndpointFilter<RequestLoggingEndpointFilter>()
.AddEndpointFilter<ValidationEndpointFilter>();
novelScoped.MapGet("/", async (Guid novelId, int? days, ActivityService service, CancellationToken ct) =>
Results.Ok(await service.GetForNovelAsync(novelId, days, ct)))
.WithSummary("Get a novel's daily activity calendar.");
var mine = app.MapGroup("/api/activity").WithTags("Activity")
.AddEndpointFilter<RequestLoggingEndpointFilter>()
.AddEndpointFilter<ValidationEndpointFilter>();
mine.MapGet("/", async (int? days, ActivityService service, CancellationToken ct) =>
Results.Ok(await service.GetForCurrentUserAsync(days, ct)))
.WithSummary("Get the current user's daily activity calendar across every visible novel.");
return app;
}
}
+74
View File
@@ -0,0 +1,74 @@
using Microsoft.EntityFrameworkCore;
using Microsoft.EntityFrameworkCore.Metadata.Builders;
using Novelly.Api.Novels;
using Novelly.Api.Users;
namespace Novelly.Api.Activity;
public enum ActivityEntityKind
{
Novel,
Chapter,
Beat,
Character,
ArcStage,
Tag,
Location,
Question
}
public enum ActivityAction
{
Created,
Updated,
Deleted,
Restored
}
public class ActivityEvent
{
public Guid Id { get; set; } = Guid.NewGuid();
public Guid NovelId { get; set; }
public Novel? Novel { get; set; }
public Guid? UserId { get; set; }
public NovellyUser? User { get; set; }
public DateTimeOffset OccurredAt { get; set; } = DateTimeOffset.UtcNow;
public int DayKey { get; set; } = ActivityDayKey.For(DateTimeOffset.UtcNow);
public ActivityEntityKind EntityKind { get; set; }
public ActivityAction Action { get; set; }
public Guid EntityId { get; set; }
public int WordDelta { get; set; }
}
public static class ActivityDayKey
{
public static int For(DateTimeOffset occurredAt) =>
occurredAt.UtcDateTime.Year * 10000 + occurredAt.UtcDateTime.Month * 100 + occurredAt.UtcDateTime.Day;
public static int For(DateOnly date) => date.Year * 10000 + date.Month * 100 + date.Day;
public static DateOnly ToDate(int dayKey) => new(dayKey / 10000, dayKey / 100 % 100, dayKey % 100);
}
public class ActivityEventEntityTypeConfiguration : IEntityTypeConfiguration<ActivityEvent>
{
public void Configure(EntityTypeBuilder<ActivityEvent> entity)
{
entity.Property(e => e.EntityKind).HasConversion<string>().HasMaxLength(32);
entity.Property(e => e.Action).HasConversion<string>().HasMaxLength(32);
entity.HasIndex(e => new { e.NovelId, e.DayKey });
entity.HasIndex(e => new { e.UserId, e.DayKey });
entity.HasOne(e => e.Novel).WithMany()
.HasForeignKey(e => e.NovelId).OnDelete(DeleteBehavior.Cascade);
entity.HasOne(e => e.User).WithMany()
.HasForeignKey(e => e.UserId).OnDelete(DeleteBehavior.SetNull);
}
}
+28
View File
@@ -0,0 +1,28 @@
using Novelly.Api.Data;
using Novelly.Api.Users;
namespace Novelly.Api.Activity;
public class ActivityLog(INovelDbContext db, INovelUserContext userContext, ILogger<ActivityLog> logger)
{
public void Record(Guid novelId, ActivityEntityKind kind, ActivityAction action, Guid entityId, int wordDelta = 0)
{
var occurredAt = DateTimeOffset.UtcNow;
logger.LogDebug(
"Recording activity {Action} on {EntityKind} {EntityId} for novel {NovelId}, word delta {WordDelta}",
action, kind, entityId, novelId, wordDelta);
db.ActivityEvents.Add(new ActivityEvent
{
NovelId = novelId,
UserId = userContext.UserId,
OccurredAt = occurredAt,
DayKey = ActivityDayKey.For(occurredAt),
EntityKind = kind,
Action = action,
EntityId = entityId,
WordDelta = wordDelta
});
}
}
@@ -0,0 +1,60 @@
using Microsoft.EntityFrameworkCore;
using Novelly.Api.Common;
using Novelly.Api.Data;
using Novelly.Api.Users;
namespace Novelly.Api.Activity;
public class ActivityService(INovelDbContext db, NovelAccessService access, ILogger<ActivityService> logger)
{
private const int MinDays = 1;
private const int MaxDays = 400;
private const int DefaultDays = 365;
public async Task<ActivityCalendarResponse> GetForNovelAsync(Guid novelId, int? days, CancellationToken ct = default)
{
Guard.Default(novelId, nameof(novelId));
logger.LogInformation("Getting activity calendar for novel {NovelId}", novelId);
await access.RequireAsync(novelId, NovelPermission.Read, ct);
return await BuildCalendarAsync(db.ActivityEvents.Where(e => e.NovelId == novelId), days, ct);
}
public async Task<ActivityCalendarResponse> GetForCurrentUserAsync(int? days, CancellationToken ct = default)
{
logger.LogInformation("Getting activity calendar for current user");
var visibleNovelIds = await access.VisibleNovels().Select(n => n.Id).ToListAsync(ct);
return await BuildCalendarAsync(db.ActivityEvents.Where(e => visibleNovelIds.Contains(e.NovelId)), days, ct);
}
private static async Task<ActivityCalendarResponse> BuildCalendarAsync(
IQueryable<ActivityEvent> query, int? requestedDays, CancellationToken ct)
{
var days = Math.Clamp(requestedDays ?? DefaultDays, MinDays, MaxDays);
var to = DateOnly.FromDateTime(DateTime.UtcNow);
var from = to.AddDays(-(days - 1));
var fromKey = ActivityDayKey.For(from);
var grouped = await query
.Where(e => e.DayKey >= fromKey)
.GroupBy(e => e.DayKey)
.Select(g => new { DayKey = g.Key, Words = g.Sum(e => e.WordDelta), Edits = g.Count() })
.ToListAsync(ct);
var responseDays = grouped
.OrderBy(g => g.DayKey)
.Select(g => new ActivityDayResponse(ActivityDayKey.ToDate(g.DayKey), g.Words, g.Edits))
.ToList();
return new ActivityCalendarResponse(
from,
to,
responseDays.Sum(d => d.Words),
responseDays.Sum(d => d.Edits),
responseDays);
}
}
+1 -1
View File
@@ -2,7 +2,7 @@ using System.Text.Json;
namespace Novelly.Api.Agent; namespace Novelly.Api.Agent;
public record AgentToolDefinition(string Name, string Description, JsonElement InputSchema); public record AgentToolDefinition(string Name, string Description, JsonElement InputSchema, bool RequiresNovelId = false);
public abstract record AgentContentBlock; public abstract record AgentContentBlock;
+12 -4
View File
@@ -43,7 +43,7 @@ public class NovelAgentService(
logger.LogInformation("Getting agent conversation {ConversationId}", conversationId); logger.LogInformation("Getting agent conversation {ConversationId}", conversationId);
return await FindConversationAsync(conversationId, ct); return await FindConversationAsync(conversationId, null, ct);
} }
public async Task<bool> DeleteConversationAsync(Guid conversationId, CancellationToken ct = default) public async Task<bool> DeleteConversationAsync(Guid conversationId, CancellationToken ct = default)
@@ -52,7 +52,7 @@ public class NovelAgentService(
logger.LogInformation("Deleting agent conversation {ConversationId}", conversationId); logger.LogInformation("Deleting agent conversation {ConversationId}", conversationId);
var conversation = await FindConversationAsync(conversationId, ct); var conversation = await FindConversationAsync(conversationId, null, ct);
if (conversation is null) if (conversation is null)
{ {
return false; return false;
@@ -81,7 +81,7 @@ public class NovelAgentService(
} }
var conversation = request.ConversationId is { } id var conversation = request.ConversationId is { } id
? await FindConversationAsync(id, ct) ? await FindConversationAsync(id, novelId, ct)
: StartConversation(novelId, request.Message); : StartConversation(novelId, request.Message);
if (conversation is null) return null; if (conversation is null) return null;
@@ -181,7 +181,7 @@ public class NovelAgentService(
return conversation; return conversation;
} }
private async Task<AgentConversation?> FindConversationAsync(Guid conversationId, CancellationToken ct) private async Task<AgentConversation?> FindConversationAsync(Guid conversationId, Guid? novelId, CancellationToken ct)
{ {
logger.LogDebug("Finding agent conversation {ConversationId}", conversationId); logger.LogDebug("Finding agent conversation {ConversationId}", conversationId);
@@ -195,6 +195,14 @@ public class NovelAgentService(
return conversation; return conversation;
} }
if (novelId is { } expectedNovelId && conversation.NovelId != expectedNovelId)
{
logger.LogWarning(
"AgentConversation {ConversationId} belongs to novel {ActualNovelId}, not requested novel {NovelId}",
conversationId, conversation.NovelId, expectedNovelId);
return null;
}
logger.LogDebug("Found agent conversation {ConversationId}", conversationId); logger.LogDebug("Found agent conversation {ConversationId}", conversationId);
return conversation; return conversation;
} }
+445 -149
View File
@@ -21,13 +21,15 @@ public record AgentTool(
string Name, string Name,
string Description, string Description,
JsonElement InputSchema, JsonElement InputSchema,
Func<Guid, JsonElement, CancellationToken, Task<object?>> Handler); Func<Guid, JsonElement, CancellationToken, Task<object?>> Handler,
bool RequiresNovelId = false);
public class NovelAgentToolset( public class NovelAgentToolset(
NovelService novels, NovelService novels,
CharacterService characters, CharacterService characters,
CharacterArcService arcs, CharacterArcService arcs,
ChapterService chapters, ChapterService chapters,
ChapterDisplayNumberLookup chapterLabels,
BeatService beats, BeatService beats,
TagService tags, TagService tags,
LocationService locations, LocationService locations,
@@ -45,7 +47,7 @@ public class NovelAgentToolset(
private IReadOnlyList<AgentTool> Tools => [.. ByName.Values]; private IReadOnlyList<AgentTool> Tools => [.. ByName.Values];
public IReadOnlyList<AgentToolDefinition> Definitions => public IReadOnlyList<AgentToolDefinition> Definitions =>
[.. Tools.Select(t => new AgentToolDefinition(t.Name, t.Description, t.InputSchema))]; [.. Tools.Select(t => new AgentToolDefinition(t.Name, t.Description, t.InputSchema, t.RequiresNovelId))];
public async Task<AgentToolResult> ExecuteAsync(string name, Guid novelId, JsonElement input, CancellationToken ct = default) public async Task<AgentToolResult> ExecuteAsync(string name, Guid novelId, JsonElement input, CancellationToken ct = default)
{ {
@@ -96,12 +98,45 @@ public class NovelAgentToolset(
private IEnumerable<AgentTool> Build() private IEnumerable<AgentTool> Build()
{ {
yield return new AgentTool(
"list_novels",
"List every novel, with counts of characters, chapters and drafted words. "
+ "Start here to find the novel id everything else needs.",
new JsonSchemaBuilder().Build(),
async (_, _, ct) => await novels.ListAsync(ct));
yield return new AgentTool(
"create_novel",
"Create a new novel.",
new JsonSchemaBuilder()
.Str("title", "Working title.", required: true)
.Str("author", "Author name.")
.Str("genre", "Genre or category.")
.Str("logline", "One-sentence pitch.")
.Str("synopsis", "Paragraph-length summary of the whole book.")
.Str("notes", "Free-form notes on theme, tone, comparable titles.")
.Int("targetWordCount", "Target manuscript length in words.")
.Build(),
async (_, input, ct) =>
{
var novel = await novels.CreateAsync(new CreateNovelRequest(
JsonInput.RequiredString(input, "title"),
JsonInput.String(input, "author"),
JsonInput.String(input, "genre"),
JsonInput.String(input, "logline"),
JsonInput.String(input, "synopsis"),
JsonInput.String(input, "notes"),
JsonInput.Int(input, "targetWordCount")), ct);
return novel.ToResponse(null);
});
yield return new AgentTool( yield return new AgentTool(
"get_novel_brief", "get_novel_brief",
"Read the novel's title, logline, synopsis, genre, notes and word-count target. " "Read the novel's title, logline, synopsis, genre, notes and word-count target. "
+ "Call this first in a conversation to ground yourself in what the book is.", + "Call this first in a conversation to ground yourself in what the book is.",
new JsonSchemaBuilder().Build(), new JsonSchemaBuilder().Build(),
async (novelId, _, ct) => await OrNotFound(novels.GetAsync(novelId, ct), p => p.ToResponse(null), "Novel", novelId)); async (novelId, _, ct) => await OrNotFound(novels.GetAsync(novelId, ct), p => p.ToResponse(null), "Novel", novelId),
RequiresNovelId: true);
yield return new AgentTool( yield return new AgentTool(
"update_novel_brief", "update_novel_brief",
@@ -114,7 +149,7 @@ public class NovelAgentToolset(
.Str("logline", "One-sentence pitch.") .Str("logline", "One-sentence pitch.")
.Str("synopsis", "Paragraph-length summary of the whole book.") .Str("synopsis", "Paragraph-length summary of the whole book.")
.Str("notes", "Free-form notes on theme, tone, comparable titles.") .Str("notes", "Free-form notes on theme, tone, comparable titles.")
.Int("target_word_count", "Target manuscript length in words.") .Int("targetWordCount", "Target manuscript length in words.")
.Build(), .Build(),
async (novelId, input, ct) => await OrNotFound(novels.UpdateAsync(novelId, new UpdateNovelRequest( async (novelId, input, ct) => await OrNotFound(novels.UpdateAsync(novelId, new UpdateNovelRequest(
JsonInput.String(input, "title"), JsonInput.String(input, "title"),
@@ -123,13 +158,27 @@ public class NovelAgentToolset(
JsonInput.String(input, "logline"), JsonInput.String(input, "logline"),
JsonInput.String(input, "synopsis"), JsonInput.String(input, "synopsis"),
JsonInput.String(input, "notes"), JsonInput.String(input, "notes"),
JsonInput.Int(input, "target_word_count")), ct), p => p.ToResponse(null), "Novel", novelId)); JsonInput.Int(input, "targetWordCount")), ct), p => p.ToResponse(null), "Novel", novelId),
RequiresNovelId: true);
yield return new AgentTool( yield return new AgentTool(
"list_characters", "list_characters",
"List every character in the novel with their full dossiers.", "List every character in the novel with their full dossiers.",
new JsonSchemaBuilder().Build(), new JsonSchemaBuilder().Build(),
async (novelId, _, ct) => (await characters.ListAsync(novelId, ct)).Select(c => c.ToResponse())); async (novelId, _, ct) => (await characters.ListAsync(novelId, ct)).Select(c => c.ToResponse()),
RequiresNovelId: true);
yield return new AgentTool(
"get_character",
"Read one character's dossier.",
new JsonSchemaBuilder()
.Str("characterId", "Id of the character to read.", required: true)
.Build(),
async (_, input, ct) =>
{
var characterId = JsonInput.RequiredGuid(input, "characterId");
return await OrNotFound(characters.GetAsync(characterId, ct), c => c.ToResponse(), "Character", characterId);
});
yield return new AgentTool( yield return new AgentTool(
"create_character", "create_character",
@@ -146,25 +195,23 @@ public class NovelAgentToolset(
JsonInput.String(input, "appearance"), JsonInput.String(input, "appearance"),
JsonInput.String(input, "personality"), JsonInput.String(input, "personality"),
JsonInput.String(input, "backstory"), JsonInput.String(input, "backstory"),
JsonInput.String(input, "want"), JsonInput.String(input, "motivation"),
JsonInput.String(input, "need"), JsonInput.String(input, "conflict"),
JsonInput.String(input, "internal_conflict"),
JsonInput.String(input, "external_conflict"),
JsonInput.String(input, "arc_summary"),
JsonInput.String(input, "voice"), JsonInput.String(input, "voice"),
JsonInput.String(input, "notes"), JsonInput.String(input, "notes"),
JsonInput.Strings(input, "tags"), JsonInput.Strings(input, "tags"),
JsonInput.Strings(input, "aliases")), ct), c => c.ToResponse(), "Novel", novelId)); JsonInput.Strings(input, "aliases")), ct), c => c.ToResponse(), "Novel", novelId),
RequiresNovelId: true);
yield return new AgentTool( yield return new AgentTool(
"update_character", "update_character",
"Revise an existing character dossier. Only the fields you supply change.", "Revise an existing character dossier. Only the fields you supply change.",
CharacterSchema(includeName: true, nameRequired: false) CharacterSchema(includeName: true, nameRequired: false)
.Str("character_id", "Id of the character to update.", required: true) .Str("characterId", "Id of the character to update.", required: true)
.Build(), .Build(),
async (_, input, ct) => async (_, input, ct) =>
{ {
var characterId = JsonInput.RequiredGuid(input, "character_id"); var characterId = JsonInput.RequiredGuid(input, "characterId");
return await OrNotFound(characters.UpdateAsync( return await OrNotFound(characters.UpdateAsync(
characterId, characterId,
new UpdateCharacterRequest( new UpdateCharacterRequest(
@@ -177,36 +224,57 @@ public class NovelAgentToolset(
JsonInput.String(input, "appearance"), JsonInput.String(input, "appearance"),
JsonInput.String(input, "personality"), JsonInput.String(input, "personality"),
JsonInput.String(input, "backstory"), JsonInput.String(input, "backstory"),
JsonInput.String(input, "want"), JsonInput.String(input, "motivation"),
JsonInput.String(input, "need"), JsonInput.String(input, "conflict"),
JsonInput.String(input, "internal_conflict"),
JsonInput.String(input, "external_conflict"),
JsonInput.String(input, "arc_summary"),
JsonInput.String(input, "voice"), JsonInput.String(input, "voice"),
JsonInput.String(input, "notes"), JsonInput.String(input, "notes"),
JsonInput.Strings(input, "tags"), JsonInput.Strings(input, "tags"),
JsonInput.Strings(input, "aliases")), ct), c => c.ToResponse(), "Character", characterId); JsonInput.Strings(input, "aliases")), ct), c => c.ToResponse(), "Character", characterId);
}); });
yield return new AgentTool(
"relate_characters",
"Record a relationship between two characters in the same novel. Creates both directions "
+ "at once — characterId's side and relatedCharacterId's side — so the pair always shows up "
+ "on both dossiers.",
new JsonSchemaBuilder()
.Str("characterId", "Id of the character the relationship belongs to.", required: true)
.Str("relatedCharacterId", "Id of the character they are related to.", required: true)
.Str("relationshipType", "How characterId is related to relatedCharacterId, e.g. 'sister', 'rival', 'former mentor'.", required: true)
.Str("reciprocalRelationshipType", "How relatedCharacterId is related back to characterId, if different. Defaults to relationshipType when the relation is symmetric, like 'rival'.")
.Str("description", "What the relationship is like, and where it is headed.")
.Build(),
async (_, input, ct) =>
{
var characterId = JsonInput.RequiredGuid(input, "characterId");
return await OrNotFound(characters.AddRelationshipAsync(
characterId,
new CreateRelationshipRequest(
JsonInput.RequiredGuid(input, "relatedCharacterId"),
JsonInput.RequiredString(input, "relationshipType"),
JsonInput.String(input, "description"),
JsonInput.String(input, "reciprocalRelationshipType")), ct), c => c.ToResponse(), "Character", characterId);
});
yield return new AgentTool( yield return new AgentTool(
"link_character_identity", "link_character_identity",
"Record that a character is really another character — e.g. one introduced under one name " "Record that a character is really another character — e.g. one introduced under one name "
+ "who is later revealed to be a character already in the novel under another name. Both " + "who is later revealed to be a character already in the novel under another name. Both "
+ "keep their own dossier and beats; the canonical identity is whichever character you link to.", + "keep their own dossier and beats; the canonical identity is whichever character you link to.",
new JsonSchemaBuilder() new JsonSchemaBuilder()
.Str("character_id", "Id of the character being revealed as someone else.", required: true) .Str("characterId", "Id of the character being revealed as someone else.", required: true)
.Str("same_character_as_id", "Id of the character this one really is.", required: true) .Str("sameCharacterAsId", "Id of the character this one really is.", required: true)
.Str("revealed_in_chapter_id", "Id of the chapter where the reveal happens, if any.") .Str("revealedInChapterId", "Id of the chapter where the reveal happens, if any.")
.Str("note", "Context on the reveal, e.g. how and why the disguise held.") .Str("note", "Context on the reveal, e.g. how and why the disguise held.")
.Build(), .Build(),
async (_, input, ct) => async (_, input, ct) =>
{ {
var characterId = JsonInput.RequiredGuid(input, "character_id"); var characterId = JsonInput.RequiredGuid(input, "characterId");
return await OrNotFound(characters.LinkIdentityAsync( return await OrNotFound(characters.LinkIdentityAsync(
characterId, characterId,
new LinkCharacterIdentityRequest( new LinkCharacterIdentityRequest(
JsonInput.RequiredGuid(input, "same_character_as_id"), JsonInput.RequiredGuid(input, "sameCharacterAsId"),
JsonInput.Guid(input, "revealed_in_chapter_id"), JsonInput.Guid(input, "revealedInChapterId"),
JsonInput.String(input, "note")), ct), c => c.ToResponse(), "Character", characterId); JsonInput.String(input, "note")), ct), c => c.ToResponse(), "Character", characterId);
}); });
@@ -214,11 +282,11 @@ public class NovelAgentToolset(
"unlink_character_identity", "unlink_character_identity",
"Remove a character's identity link, restoring it to its own separate identity.", "Remove a character's identity link, restoring it to its own separate identity.",
new JsonSchemaBuilder() new JsonSchemaBuilder()
.Str("character_id", "Id of the character to unlink.", required: true) .Str("characterId", "Id of the character to unlink.", required: true)
.Build(), .Build(),
async (_, input, ct) => async (_, input, ct) =>
{ {
var characterId = JsonInput.RequiredGuid(input, "character_id"); var characterId = JsonInput.RequiredGuid(input, "characterId");
return await DeletedOrNotFound(characters.UnlinkIdentityAsync(characterId, ct), "Character", characterId); return await DeletedOrNotFound(characters.UnlinkIdentityAsync(characterId, ct), "Character", characterId);
}); });
@@ -227,29 +295,29 @@ public class NovelAgentToolset(
"Read a chapter's outline: its summary paragraph and its beat table, in order. " "Read a chapter's outline: its summary paragraph and its beat table, in order. "
+ "A beat is one row — a short title, whose beat it is, what happened, and what it sets up.", + "A beat is one row — a short title, whose beat it is, what happened, and what it sets up.",
new JsonSchemaBuilder() new JsonSchemaBuilder()
.Str("chapter_id", "Id of the chapter whose outline to read.", required: true) .Str("chapterId", "Id of the chapter whose outline to read.", required: true)
.Build(), .Build(),
async (_, input, ct) => (await beats.ListAsync(JsonInput.RequiredGuid(input, "chapter_id"), ct)).Select(b => b.ToResponse())); async (_, input, ct) => (await beats.ListAsync(JsonInput.RequiredGuid(input, "chapterId"), ct)).Select(b => b.ToResponse()));
yield return new AgentTool( yield return new AgentTool(
"create_beat", "create_beat",
"Add a beat to a chapter's outline. Keep the title to three to five words — it is a " "Add a beat to a chapter's outline. Keep the title to three to five words — it is a "
+ "handle, not a sentence; the detail belongs in what_happened and whats_next.", + "handle, not a sentence; the detail belongs in whatHappened and whatsNext.",
BeatSchema() BeatSchema()
.Str("chapter_id", "Id of the chapter the beat belongs to.", required: true) .Str("chapterId", "Id of the chapter the beat belongs to.", required: true)
.Str("title", "Three to five words naming the beat.", required: true) .Str("title", "Three to five words naming the beat.", required: true)
.Build(), .Build(),
async (_, input, ct) => async (_, input, ct) =>
{ {
var chapterId = JsonInput.RequiredGuid(input, "chapter_id"); var chapterId = JsonInput.RequiredGuid(input, "chapterId");
return await OrNotFound(beats.CreateAsync( return await OrNotFound(beats.CreateAsync(
chapterId, chapterId,
new CreateBeatRequest( new CreateBeatRequest(
JsonInput.RequiredString(input, "title"), JsonInput.RequiredString(input, "title"),
JsonInput.Int(input, "sort_order"), JsonInput.Int(input, "sortOrder"),
JsonInput.Guids(input, "character_ids"), JsonInput.Guids(input, "characterIds"),
JsonInput.String(input, "what_happened"), JsonInput.String(input, "whatHappened"),
JsonInput.String(input, "whats_next"), JsonInput.String(input, "whatsNext"),
JsonInput.Strings(input, "tags")), ct), b => b.ToResponse(), "Chapter", chapterId); JsonInput.Strings(input, "tags")), ct), b => b.ToResponse(), "Chapter", chapterId);
}); });
@@ -258,20 +326,20 @@ public class NovelAgentToolset(
"Revise a beat. Only the fields you supply change. Supplying a tag list replaces " "Revise a beat. Only the fields you supply change. Supplying a tag list replaces "
+ "the beat's tags outright, so include the ones you want to keep.", + "the beat's tags outright, so include the ones you want to keep.",
BeatSchema() BeatSchema()
.Str("beat_id", "Id of the beat to update.", required: true) .Str("beatId", "Id of the beat to update.", required: true)
.Str("title", "Three to five words naming the beat.") .Str("title", "Three to five words naming the beat.")
.Build(), .Build(),
async (_, input, ct) => async (_, input, ct) =>
{ {
var beatId = JsonInput.RequiredGuid(input, "beat_id"); var beatId = JsonInput.RequiredGuid(input, "beatId");
return await OrNotFound(beats.UpdateAsync( return await OrNotFound(beats.UpdateAsync(
beatId, beatId,
new UpdateBeatRequest( new UpdateBeatRequest(
JsonInput.String(input, "title"), JsonInput.String(input, "title"),
JsonInput.Int(input, "sort_order"), JsonInput.Int(input, "sortOrder"),
JsonInput.Guids(input, "character_ids"), JsonInput.Guids(input, "characterIds"),
JsonInput.String(input, "what_happened"), JsonInput.String(input, "whatHappened"),
JsonInput.String(input, "whats_next"), JsonInput.String(input, "whatsNext"),
JsonInput.Strings(input, "tags")), ct), b => b.ToResponse(), "Beat", beatId); JsonInput.Strings(input, "tags")), ct), b => b.ToResponse(), "Beat", beatId);
}); });
@@ -279,11 +347,11 @@ public class NovelAgentToolset(
"delete_beat", "delete_beat",
"Remove a beat from a chapter's outline. Confirm with the writer before calling it.", "Remove a beat from a chapter's outline. Confirm with the writer before calling it.",
new JsonSchemaBuilder() new JsonSchemaBuilder()
.Str("beat_id", "Id of the beat to delete.", required: true) .Str("beatId", "Id of the beat to delete.", required: true)
.Build(), .Build(),
async (_, input, ct) => async (_, input, ct) =>
{ {
var beatId = JsonInput.RequiredGuid(input, "beat_id"); var beatId = JsonInput.RequiredGuid(input, "beatId");
return await DeletedOrNotFound(beats.DeleteAsync(beatId, ct), "Beat", beatId); return await DeletedOrNotFound(beats.DeleteAsync(beatId, ct), "Beat", beatId);
}); });
@@ -292,16 +360,16 @@ public class NovelAgentToolset(
"Renumber a chapter's beats to match the order given. List every beat id in the " "Renumber a chapter's beats to match the order given. List every beat id in the "
+ "order you want; any you leave out keep their relative position at the end.", + "order you want; any you leave out keep their relative position at the end.",
new JsonSchemaBuilder() new JsonSchemaBuilder()
.Str("chapter_id", "Id of the chapter whose beats to reorder.", required: true) .Str("chapterId", "Id of the chapter whose beats to reorder.", required: true)
.StringArray("beat_ids", "Beat ids in their new order.", required: true) .StringArray("beatIds", "Beat ids in their new order.", required: true)
.Build(), .Build(),
async (_, input, ct) => async (_, input, ct) =>
{ {
var chapterId = JsonInput.RequiredGuid(input, "chapter_id"); var chapterId = JsonInput.RequiredGuid(input, "chapterId");
return await OrNotFound(beats.ReorderAsync( return await OrNotFound(beats.ReorderAsync(
chapterId, chapterId,
new ReorderBeatsRequest( new ReorderBeatsRequest(
[.. (JsonInput.Strings(input, "beat_ids") ?? []) [.. (JsonInput.Strings(input, "beatIds") ?? [])
.Select(id => Guid.TryParse(id, out var g) ? g : Guid.Empty) .Select(id => Guid.TryParse(id, out var g) ? g : Guid.Empty)
.Where(g => g != Guid.Empty)]), ct), list => list.Select(b => b.ToResponse()), "Chapter", chapterId); .Where(g => g != Guid.Empty)]), ct), list => list.Select(b => b.ToResponse()), "Chapter", chapterId);
}); });
@@ -311,18 +379,18 @@ public class NovelAgentToolset(
"Add a character to several beats at once. Leaves each beat's existing characters and " "Add a character to several beats at once. Leaves each beat's existing characters and "
+ "other fields alone — this only adds, it never removes.", + "other fields alone — this only adds, it never removes.",
new JsonSchemaBuilder() new JsonSchemaBuilder()
.Str("chapter_id", "Id of the chapter the beats belong to.", required: true) .Str("chapterId", "Id of the chapter the beats belong to.", required: true)
.Str("character_id", "Id of the character to add.", required: true) .Str("characterId", "Id of the character to add.", required: true)
.StringArray("beat_ids", "Ids of the beats to add the character to.", required: true) .StringArray("beatIds", "Ids of the beats to add the character to.", required: true)
.Build(), .Build(),
async (_, input, ct) => async (_, input, ct) =>
{ {
var chapterId = JsonInput.RequiredGuid(input, "chapter_id"); var chapterId = JsonInput.RequiredGuid(input, "chapterId");
return await OrNotFound(beats.AssignCharacterAsync( return await OrNotFound(beats.AssignCharacterAsync(
chapterId, chapterId,
new AssignCharacterToBeatsRequest( new AssignCharacterToBeatsRequest(
JsonInput.RequiredGuid(input, "character_id"), JsonInput.RequiredGuid(input, "characterId"),
[.. (JsonInput.Strings(input, "beat_ids") ?? []) [.. (JsonInput.Strings(input, "beatIds") ?? [])
.Select(id => Guid.TryParse(id, out var g) ? g : Guid.Empty) .Select(id => Guid.TryParse(id, out var g) ? g : Guid.Empty)
.Where(g => g != Guid.Empty)]), ct), list => list.Select(b => b.ToResponse()), "Chapter", chapterId); .Where(g => g != Guid.Empty)]), ct), list => list.Select(b => b.ToResponse()), "Chapter", chapterId);
}); });
@@ -332,18 +400,18 @@ public class NovelAgentToolset(
"Move one or more beats from one chapter to another, appending them to the target " "Move one or more beats from one chapter to another, appending them to the target "
+ "chapter's end in the order given.", + "chapter's end in the order given.",
new JsonSchemaBuilder() new JsonSchemaBuilder()
.Str("chapter_id", "Id of the beats' current chapter.", required: true) .Str("chapterId", "Id of the beats' current chapter.", required: true)
.Str("target_chapter_id", "Id of the chapter to move the beats into.", required: true) .Str("targetChapterId", "Id of the chapter to move the beats into.", required: true)
.StringArray("beat_ids", "Ids of the beats to move.", required: true) .StringArray("beatIds", "Ids of the beats to move.", required: true)
.Build(), .Build(),
async (_, input, ct) => async (_, input, ct) =>
{ {
var chapterId = JsonInput.RequiredGuid(input, "chapter_id"); var chapterId = JsonInput.RequiredGuid(input, "chapterId");
return await OrNotFound(beats.MoveAsync( return await OrNotFound(beats.MoveAsync(
chapterId, chapterId,
new MoveBeatsRequest( new MoveBeatsRequest(
JsonInput.RequiredGuid(input, "target_chapter_id"), JsonInput.RequiredGuid(input, "targetChapterId"),
[.. (JsonInput.Strings(input, "beat_ids") ?? []) [.. (JsonInput.Strings(input, "beatIds") ?? [])
.Select(id => Guid.TryParse(id, out var g) ? g : Guid.Empty) .Select(id => Guid.TryParse(id, out var g) ? g : Guid.Empty)
.Where(g => g != Guid.Empty)]), ct), list => list.Select(b => b.ToResponse()), "Chapter", chapterId); .Where(g => g != Guid.Empty)]), ct), list => list.Select(b => b.ToResponse()), "Chapter", chapterId);
}); });
@@ -353,19 +421,72 @@ public class NovelAgentToolset(
"List the novel's tags with how many characters, chapters and beats carry each. " "List the novel's tags with how many characters, chapters and beats carry each. "
+ "Read this before inventing a new tag so you reuse the writer's vocabulary.", + "Read this before inventing a new tag so you reuse the writer's vocabulary.",
new JsonSchemaBuilder().Build(), new JsonSchemaBuilder().Build(),
async (novelId, _, ct) => await tags.ListAsync(novelId, ct)); async (novelId, _, ct) => await tags.ListAsync(novelId, ct),
RequiresNovelId: true);
yield return new AgentTool( yield return new AgentTool(
"get_tag_references", "get_tag_references",
"Cross-reference a tag: every character, chapter and beat carrying it. Use this to " "Cross-reference a tag: every character, chapter and beat carrying it. Use this to "
+ "trace a motif or a thread through the book.", + "trace a motif or a thread through the book.",
new JsonSchemaBuilder() new JsonSchemaBuilder()
.Str("tag_id", "Id of the tag to trace.", required: true) .Str("tagId", "Id of the tag to trace.", required: true)
.Build(), .Build(),
async (_, input, ct) => async (_, input, ct) =>
{ {
var tagId = JsonInput.RequiredGuid(input, "tag_id"); var tagId = JsonInput.RequiredGuid(input, "tagId");
return await OrNotFound(tags.GetReferencesAsync(tagId, ct), t => t.ToReferencesResponse(), "Tag", tagId); var tag = await tags.GetReferencesAsync(tagId, ct);
if (tag is null)
{
return new ToolNotFound("Tag", tagId);
}
var displayNumbers = await chapterLabels.ForNovelAsync(tag.NovelId, ct);
return tag.ToReferencesResponse(displayNumbers);
});
yield return new AgentTool(
"create_tag",
"Create a tag explicitly. Applying an unknown tag by name to a character, chapter or "
+ "beat also creates it, so this is only needed to set a colour up front.",
new JsonSchemaBuilder()
.Str("name", "The tag's name. Unique within the novel, matched case-insensitively.", required: true)
.Str("color", "Optional hex colour for the UI, e.g. \"#9a4a2f\".")
.Build(),
async (novelId, input, ct) => await OrNotFound(tags.CreateAsync(
novelId,
new CreateTagRequest(
JsonInput.RequiredString(input, "name"),
JsonInput.String(input, "color")), ct), t => t.ToResponse(), "Novel", novelId),
RequiresNovelId: true);
yield return new AgentTool(
"update_tag",
"Rename or recolour a tag. Renaming updates it everywhere it is applied.",
new JsonSchemaBuilder()
.Str("tagId", "Id of the tag to update.", required: true)
.Str("name", "New name.")
.Str("color", "Hex colour, e.g. \"#9a4a2f\".")
.Build(),
async (_, input, ct) =>
{
var tagId = JsonInput.RequiredGuid(input, "tagId");
return await OrNotFound(tags.UpdateAsync(
tagId,
new UpdateTagRequest(
JsonInput.String(input, "name"),
JsonInput.String(input, "color")), ct), t => t.ToResponse(), "Tag", tagId);
});
yield return new AgentTool(
"delete_tag",
"Delete a tag. Whatever carried it is left alone — only the label goes.",
new JsonSchemaBuilder()
.Str("tagId", "Id of the tag to delete.", required: true)
.Build(),
async (_, input, ct) =>
{
var tagId = JsonInput.RequiredGuid(input, "tagId");
return await DeletedOrNotFound(tags.DeleteAsync(tagId, ct), "Tag", tagId);
}); });
yield return new AgentTool( yield return new AgentTool(
@@ -373,95 +494,181 @@ public class NovelAgentToolset(
"List the novel's locations with how many chapters are set there. " "List the novel's locations with how many chapters are set there. "
+ "Read this before inventing a new location so you reuse the writer's vocabulary.", + "Read this before inventing a new location so you reuse the writer's vocabulary.",
new JsonSchemaBuilder().Build(), new JsonSchemaBuilder().Build(),
async (novelId, _, ct) => await locations.ListAsync(novelId, ct)); async (novelId, _, ct) => await locations.ListAsync(novelId, ct),
RequiresNovelId: true);
yield return new AgentTool( yield return new AgentTool(
"get_location_references", "get_location_references",
"Cross-reference a location: every chapter set there.", "Cross-reference a location: every chapter set there.",
new JsonSchemaBuilder() new JsonSchemaBuilder()
.Str("location_id", "Id of the location to trace.", required: true) .Str("locationId", "Id of the location to trace.", required: true)
.Build(), .Build(),
async (_, input, ct) => async (_, input, ct) =>
{ {
var locationId = JsonInput.RequiredGuid(input, "location_id"); var locationId = JsonInput.RequiredGuid(input, "locationId");
return await OrNotFound(locations.GetReferencesAsync(locationId, ct), l => l.ToReferencesResponse(), "Location", locationId); var location = await locations.GetReferencesAsync(locationId, ct);
if (location is null)
{
return new ToolNotFound("Location", locationId);
}
var displayNumbers = await chapterLabels.ForNovelAsync(location.NovelId, ct);
return location.ToReferencesResponse(displayNumbers);
});
yield return new AgentTool(
"create_location",
"Create a location explicitly. Applying an unknown location by name to a chapter also "
+ "creates it, so this is only needed to set one up ahead of time.",
new JsonSchemaBuilder()
.Str("name", "The location's name. Unique within the novel, matched case-insensitively.", required: true)
.Build(),
async (novelId, input, ct) => await OrNotFound(locations.CreateAsync(
novelId,
new CreateLocationRequest(JsonInput.RequiredString(input, "name")), ct), l => l.ToResponse(), "Novel", novelId),
RequiresNovelId: true);
yield return new AgentTool(
"update_location",
"Rename a location. Renaming updates it everywhere it is applied.",
new JsonSchemaBuilder()
.Str("locationId", "Id of the location to update.", required: true)
.Str("name", "New name.", required: true)
.Build(),
async (_, input, ct) =>
{
var locationId = JsonInput.RequiredGuid(input, "locationId");
return await OrNotFound(locations.UpdateAsync(
locationId,
new UpdateLocationRequest(JsonInput.RequiredString(input, "name")), ct), l => l.ToResponse(), "Location", locationId);
});
yield return new AgentTool(
"delete_location",
"Delete a location. Whatever carried it is left alone — only the label goes.",
new JsonSchemaBuilder()
.Str("locationId", "Id of the location to delete.", required: true)
.Build(),
async (_, input, ct) =>
{
var locationId = JsonInput.RequiredGuid(input, "locationId");
return await DeletedOrNotFound(locations.DeleteAsync(locationId, ct), "Location", locationId);
}); });
yield return new AgentTool( yield return new AgentTool(
"list_chapters", "list_chapters",
"List the novel's chapters in manuscript order with beat and word counts.", "List the novel's chapters in manuscript order with beat and word counts.",
new JsonSchemaBuilder().Build(), new JsonSchemaBuilder().Build(),
async (novelId, _, ct) => (await chapters.ListAsync(novelId, ct)).Select(c => c.ToSummaryResponse())); async (novelId, _, ct) =>
{
var list = await chapters.ListAsync(novelId, ct);
var displayNumbers = ChapterNumbering.DisplayNumbers(list);
return list.Select(c => c.ToSummaryResponse(displayNumbers.TryGetValue(c.Id, out var n) ? n : null));
},
RequiresNovelId: true);
yield return new AgentTool( yield return new AgentTool(
"get_chapter", "get_chapter",
"Read one chapter in full: its outline (beats) and its drafted prose.", "Read one chapter in full: its outline (beats) and its drafted prose.",
new JsonSchemaBuilder() new JsonSchemaBuilder()
.Str("chapter_id", "Id of the chapter to read.", required: true) .Str("chapterId", "Id of the chapter to read.", required: true)
.Build(), .Build(),
async (_, input, ct) => async (_, input, ct) =>
{ {
var chapterId = JsonInput.RequiredGuid(input, "chapter_id"); var chapterId = JsonInput.RequiredGuid(input, "chapterId");
return await OrNotFound(chapters.GetAsync(chapterId, ct), c => c.ToResponse(), "Chapter", chapterId); var chapter = await chapters.GetAsync(chapterId, ct);
if (chapter is null)
{
return new ToolNotFound("Chapter", chapterId);
}
var displayNumber = await chapters.DisplayNumberAsync(chapter, ct);
return chapter.ToResponse(displayNumber);
}); });
yield return new AgentTool( yield return new AgentTool(
"create_chapter", "create_chapter",
"Add a chapter. Its number is appended to the end of the manuscript unless you supply one.", "Add a chapter. Its number is appended to the end of the manuscript unless you supply one. "
+ "Front matter (foreword, introduction, prologue) and back matter (afterword, about the "
+ "author) are labeled by title alone and do not count against the numbered chapters.",
new JsonSchemaBuilder() new JsonSchemaBuilder()
.Str("title", "Chapter title.", required: true) .Str("title", "Chapter title.", required: true)
.Int("number", "Position in the manuscript, 1-based.") .Int("number", "Manuscript position, 1-based, counting front and back matter.")
.Enum("kind", "Front matter, a numbered body chapter, or back matter. Defaults to a body chapter.", System.Enum.GetNames<ChapterKind>())
.Str("summary", "What the chapter covers.") .Str("summary", "What the chapter covers.")
.StringArray("locations", "Where and when the chapter takes place. Unknown locations are created.") .StringArray("locations", "Where and when the chapter takes place. Unknown locations are created.")
.Str("notes", "Anything else worth recording.") .Str("notes", "Anything else worth recording.")
.Enum("status", "Drafting status.", System.Enum.GetNames<DraftStatus>()) .Enum("status", "Drafting status.", System.Enum.GetNames<DraftStatus>())
.Int("target_word_count", "Target length in words.") .Int("targetWordCount", "Target length in words.")
.Str("prose", "The chapter's drafted text, in markdown, if you are writing it now.") .Str("prose", "The chapter's drafted text, in markdown, if you are writing it now.")
.StringArray("tags", "Tags for cross-referencing. Replaces the existing tags.") .StringArray("tags", "Tags for cross-referencing. Replaces the existing tags.")
.Build(), .Build(),
async (novelId, input, ct) => await OrNotFound(chapters.CreateAsync(novelId, new CreateChapterRequest( async (novelId, input, ct) =>
{
var chapter = await chapters.CreateAsync(novelId, new CreateChapterRequest(
JsonInput.RequiredString(input, "title"), JsonInput.RequiredString(input, "title"),
JsonInput.Int(input, "number"), JsonInput.Int(input, "number"),
JsonInput.Enum<ChapterKind>(input, "kind") ?? ChapterKind.Body,
JsonInput.String(input, "summary"), JsonInput.String(input, "summary"),
JsonInput.Strings(input, "locations"), JsonInput.Strings(input, "locations"),
JsonInput.String(input, "notes"), JsonInput.String(input, "notes"),
JsonInput.Enum<DraftStatus>(input, "status") ?? DraftStatus.Planned, JsonInput.Enum<DraftStatus>(input, "status") ?? DraftStatus.Planned,
JsonInput.Int(input, "target_word_count"), JsonInput.Int(input, "targetWordCount"),
JsonInput.String(input, "prose"), JsonInput.String(input, "prose"),
JsonInput.Strings(input, "tags")), ct), c => c.ToResponse(), "Novel", novelId)); JsonInput.Strings(input, "tags")), ct);
if (chapter is null)
{
return new ToolNotFound("Novel", novelId);
}
var displayNumber = await chapters.DisplayNumberAsync(chapter, ct);
return chapter.ToResponse(displayNumber);
},
RequiresNovelId: true);
yield return new AgentTool( yield return new AgentTool(
"update_chapter", "update_chapter",
"Revise a chapter's title, number, summary, locations, notes, status or drafted " "Revise a chapter's title, number, kind, summary, locations, notes, status or drafted "
+ "prose. Use 'prose' to write or replace the chapter's draft text in markdown; the " + "prose. Use 'prose' to write or replace the chapter's draft text in markdown; the "
+ "word count is recomputed automatically.", + "word count is recomputed automatically.",
new JsonSchemaBuilder() new JsonSchemaBuilder()
.Str("chapter_id", "Id of the chapter to update.", required: true) .Str("chapterId", "Id of the chapter to update.", required: true)
.Str("title", "New title.") .Str("title", "New title.")
.Int("number", "Position in the manuscript.") .Int("number", "Manuscript position, 1-based, counting front and back matter.")
.Enum("kind", "Front matter, a numbered body chapter, or back matter.", System.Enum.GetNames<ChapterKind>())
.Str("summary", "What the chapter covers.") .Str("summary", "What the chapter covers.")
.StringArray("locations", "Where and when the chapter takes place. Replaces the existing locations. Unknown locations are created.") .StringArray("locations", "Where and when the chapter takes place. Replaces the existing locations. Unknown locations are created.")
.Str("notes", "Anything else worth recording.") .Str("notes", "Anything else worth recording.")
.Enum("status", "Drafting status.", System.Enum.GetNames<DraftStatus>()) .Enum("status", "Drafting status.", System.Enum.GetNames<DraftStatus>())
.Int("target_word_count", "Target length in words.") .Int("targetWordCount", "Target length in words.")
.Str("prose", "The chapter's drafted text, in markdown.") .Str("prose", "The chapter's drafted text, in markdown.")
.StringArray("tags", "Tags for cross-referencing. Replaces the existing tags.") .StringArray("tags", "Tags for cross-referencing. Replaces the existing tags.")
.Build(), .Build(),
async (_, input, ct) => async (_, input, ct) =>
{ {
var chapterId = JsonInput.RequiredGuid(input, "chapter_id"); var chapterId = JsonInput.RequiredGuid(input, "chapterId");
return await OrNotFound(chapters.UpdateAsync( var chapter = await chapters.UpdateAsync(
chapterId, chapterId,
new UpdateChapterRequest( new UpdateChapterRequest(
JsonInput.String(input, "title"), JsonInput.String(input, "title"),
JsonInput.Int(input, "number"), JsonInput.Int(input, "number"),
JsonInput.Enum<ChapterKind>(input, "kind"),
JsonInput.String(input, "summary"), JsonInput.String(input, "summary"),
JsonInput.Strings(input, "locations"), JsonInput.Strings(input, "locations"),
JsonInput.String(input, "notes"), JsonInput.String(input, "notes"),
JsonInput.Enum<DraftStatus>(input, "status"), JsonInput.Enum<DraftStatus>(input, "status"),
JsonInput.Int(input, "target_word_count"), JsonInput.Int(input, "targetWordCount"),
JsonInput.String(input, "prose"), JsonInput.String(input, "prose"),
JsonInput.Strings(input, "tags")), ct), c => c.ToResponse(), "Chapter", chapterId); JsonInput.Strings(input, "tags")), ct);
if (chapter is null)
{
return new ToolNotFound("Chapter", chapterId);
}
var displayNumber = await chapters.DisplayNumberAsync(chapter, ct);
return chapter.ToResponse(displayNumber);
}); });
yield return new AgentTool( yield return new AgentTool(
@@ -470,76 +677,81 @@ public class NovelAgentToolset(
+ "Read this before revising a character — it is what they actually do on the page, " + "Read this before revising a character — it is what they actually do on the page, "
+ "as opposed to what the dossier claims about them.", + "as opposed to what the dossier claims about them.",
new JsonSchemaBuilder() new JsonSchemaBuilder()
.Str("character_id", "Id of the character.", required: true) .Str("characterId", "Id of the character.", required: true)
.Build(), .Build(),
async (_, input, ct) => async (novelId, input, ct) =>
{ {
var characterId = JsonInput.RequiredGuid(input, "character_id"); var characterId = JsonInput.RequiredGuid(input, "characterId");
return await OrNotFound( var characterBeats = await beats.ListForCharacterAsync(characterId, ct);
beats.ListForCharacterAsync(characterId, ct), if (characterBeats is null)
list => list.Select(b => b.ToCharacterBeatResponse(characterId)), {
"Character", return new ToolNotFound("Character", characterId);
characterId); }
});
var displayNumbers = await chapterLabels.ForNovelAsync(novelId, ct);
return characterBeats.Select(b =>
b.ToCharacterBeatResponse(characterId, b.Chapter is null ? null : chapterLabels.LabelFor(b.Chapter, displayNumbers)));
},
RequiresNovelId: true);
yield return new AgentTool( yield return new AgentTool(
"get_character_arc", "get_character_arc",
"Read a main character's arc: the ordered stages of how they change. Each stage may " "Read a main character's arc: the ordered stages of how they change. Each stage may "
+ "be pinned to the chapter where it lands.", + "be pinned to the chapter where it lands.",
new JsonSchemaBuilder() new JsonSchemaBuilder()
.Str("character_id", "Id of the character.", required: true) .Str("characterId", "Id of the character.", required: true)
.Build(), .Build(),
async (_, input, ct) => (await arcs.ListAsync( async (_, input, ct) => (await arcs.ListAsync(
JsonInput.RequiredGuid(input, "character_id"), ct)).Select(s => s.ToResponse())); JsonInput.RequiredGuid(input, "characterId"), ct)).Select(s => s.ToResponse()));
yield return new AgentTool( yield return new AgentTool(
"add_arc_stage", "add_arc_stage",
"Add a stage to a character's arc. Arcs are for main characters — promote the " "Add a stage to a character's arc. Arcs are for main characters — promote the "
+ "character first with update_character if they are still Supporting.", + "character first with update_character if they are still Supporting.",
ArcStageSchema() ArcStageSchema()
.Str("character_id", "Id of the character whose arc to add to.", required: true) .Str("characterId", "Id of the character whose arc to add to.", required: true)
.Str("title", "A short handle for the change, three to five words.", required: true) .Str("title", "A short handle for the change, three to five words.", required: true)
.Build(), .Build(),
async (_, input, ct) => async (_, input, ct) =>
{ {
var characterId = JsonInput.RequiredGuid(input, "character_id"); var characterId = JsonInput.RequiredGuid(input, "characterId");
return await OrNotFound(arcs.CreateAsync( return await OrNotFound(arcs.CreateAsync(
characterId, characterId,
new CreateArcStageRequest( new CreateArcStageRequest(
JsonInput.RequiredString(input, "title"), JsonInput.RequiredString(input, "title"),
JsonInput.Int(input, "sort_order"), JsonInput.Int(input, "sortOrder"),
JsonInput.String(input, "description"), JsonInput.String(input, "description"),
JsonInput.Guid(input, "chapter_id")), ct), s => s.ToResponse(), "Character", characterId); JsonInput.Guid(input, "chapterId")), ct), s => s.ToResponse(), "Character", characterId);
}); });
yield return new AgentTool( yield return new AgentTool(
"update_arc_stage", "update_arc_stage",
"Revise a stage of a character's arc. Only the fields you supply change.", "Revise a stage of a character's arc. Only the fields you supply change.",
ArcStageSchema() ArcStageSchema()
.Str("arc_stage_id", "Id of the arc stage to update.", required: true) .Str("arcStageId", "Id of the arc stage to update.", required: true)
.Str("title", "New title for the stage.") .Str("title", "New title for the stage.")
.Build(), .Build(),
async (_, input, ct) => async (_, input, ct) =>
{ {
var arcStageId = JsonInput.RequiredGuid(input, "arc_stage_id"); var arcStageId = JsonInput.RequiredGuid(input, "arcStageId");
return await OrNotFound(arcs.UpdateAsync( return await OrNotFound(arcs.UpdateAsync(
arcStageId, arcStageId,
new UpdateArcStageRequest( new UpdateArcStageRequest(
JsonInput.String(input, "title"), JsonInput.String(input, "title"),
JsonInput.Int(input, "sort_order"), JsonInput.Int(input, "sortOrder"),
JsonInput.String(input, "description"), JsonInput.String(input, "description"),
JsonInput.Guid(input, "chapter_id")), ct), s => s.ToResponse(), "CharacterArcStage", arcStageId); JsonInput.Guid(input, "chapterId")), ct), s => s.ToResponse(), "CharacterArcStage", arcStageId);
}); });
yield return new AgentTool( yield return new AgentTool(
"delete_arc_stage", "delete_arc_stage",
"Remove a stage from a character's arc.", "Remove a stage from a character's arc.",
new JsonSchemaBuilder() new JsonSchemaBuilder()
.Str("arc_stage_id", "Id of the arc stage to delete.", required: true) .Str("arcStageId", "Id of the arc stage to delete.", required: true)
.Build(), .Build(),
async (_, input, ct) => async (_, input, ct) =>
{ {
var arcStageId = JsonInput.RequiredGuid(input, "arc_stage_id"); var arcStageId = JsonInput.RequiredGuid(input, "arcStageId");
return await DeletedOrNotFound(arcs.DeleteAsync(arcStageId, ct), "CharacterArcStage", arcStageId); return await DeletedOrNotFound(arcs.DeleteAsync(arcStageId, ct), "CharacterArcStage", arcStageId);
}); });
@@ -548,16 +760,35 @@ public class NovelAgentToolset(
"Renumber a character's arc to match the order given. Stages left out keep their " "Renumber a character's arc to match the order given. Stages left out keep their "
+ "relative position after the ones listed.", + "relative position after the ones listed.",
new JsonSchemaBuilder() new JsonSchemaBuilder()
.Str("character_id", "Id of the character whose arc to reorder.", required: true) .Str("characterId", "Id of the character whose arc to reorder.", required: true)
.StringArray("stage_ids", "Arc stage ids in the order wanted.", required: true) .StringArray("stageIds", "Arc stage ids in the order wanted.", required: true)
.Build(), .Build(),
async (_, input, ct) => async (_, input, ct) =>
{ {
var characterId = JsonInput.RequiredGuid(input, "character_id"); var characterId = JsonInput.RequiredGuid(input, "characterId");
return await OrNotFound(arcs.ReorderAsync( return await OrNotFound(arcs.ReorderAsync(
characterId, characterId,
new ReorderArcStagesRequest( new ReorderArcStagesRequest(
[.. JsonInput.Strings(input, "stage_ids")?.Select(Guid.Parse) ?? []]), ct), list => list.Select(s => s.ToResponse()), "Character", characterId); [.. JsonInput.Strings(input, "stageIds")?.Select(Guid.Parse) ?? []]), ct), list => list.Select(s => s.ToResponse()), "Character", characterId);
});
yield return new AgentTool(
"set_arc_stage_beats",
"Set which beats belong to an arc stage, replacing its current set. This groups the "
+ "chapter-level beats that establish or pay off this stage of the character's arc. A "
+ "beat moved into this stage leaves any other stage of the same character it was in. "
+ "Each beat must already include this character.",
new JsonSchemaBuilder()
.Str("arcStageId", "Id of the arc stage.", required: true)
.StringArray("beatIds", "Beat ids that belong to this stage, replacing whatever was there before.", required: true)
.Build(),
async (_, input, ct) =>
{
var arcStageId = JsonInput.RequiredGuid(input, "arcStageId");
return await OrNotFound(arcs.SetBeatsAsync(
arcStageId,
new SetArcStageBeatsRequest(
[.. JsonInput.Strings(input, "beatIds")?.Select(Guid.Parse) ?? []]), ct), s => s.ToResponse(), "CharacterArcStage", arcStageId);
}); });
yield return new AgentTool( yield return new AgentTool(
@@ -565,16 +796,23 @@ public class NovelAgentToolset(
"The decisions the writer has not made yet. Read this before proposing changes — an " "The decisions the writer has not made yet. Read this before proposing changes — an "
+ "open question is a place the writer is still thinking, not a gap to fill in for them.", + "open question is a place the writer is still thinking, not a gap to fill in for them.",
new JsonSchemaBuilder() new JsonSchemaBuilder()
.Str("chapter_id", "Narrow to questions about one chapter outline.") .Str("chapterId", "Narrow to questions about one chapter outline.")
.Str("character_id", "Narrow to questions about one character.") .Str("characterId", "Narrow to questions about one character.")
.Bool("include_resolved", "Include questions already settled. Defaults to false.") .Bool("includeResolved", "Include questions already settled. Defaults to false.")
.Build(), .Build(),
async (novelId, input, ct) => (await questions.ListAsync( async (novelId, input, ct) =>
{
var list = await questions.ListAsync(
novelId, novelId,
JsonInput.Guid(input, "chapter_id"), JsonInput.Guid(input, "chapterId"),
JsonInput.Guid(input, "character_id"), JsonInput.Guid(input, "characterId"),
JsonInput.Bool(input, "include_resolved") ?? false, JsonInput.Bool(input, "includeResolved") ?? false,
ct)).Select(q => q.ToResponse())); ct);
var displayNumbers = await chapterLabels.ForNovelAsync(novelId, ct);
return list.Select(q => q.ToResponse(displayNumbers));
},
RequiresNovelId: true);
yield return new AgentTool( yield return new AgentTool(
"raise_open_question", "raise_open_question",
@@ -584,66 +822,127 @@ public class NovelAgentToolset(
new JsonSchemaBuilder() new JsonSchemaBuilder()
.Str("question", "The question, in one line.", required: true) .Str("question", "The question, in one line.", required: true)
.Str("detail", "The thinking around it — options, and what each costs.") .Str("detail", "The thinking around it — options, and what each costs.")
.Str("chapter_id", "The chapter outline this is about, if any.") .Str("chapterId", "The chapter outline this is about, if any.")
.Str("character_id", "The character this is about, if any.") .Str("characterId", "The character this is about, if any.")
.Build(), .Build(),
async (novelId, input, ct) => await OrNotFound(questions.CreateAsync( async (novelId, input, ct) =>
{
var question = await questions.CreateAsync(
novelId, novelId,
new CreateOpenQuestionRequest( new CreateOpenQuestionRequest(
JsonInput.RequiredString(input, "question"), JsonInput.RequiredString(input, "question"),
JsonInput.String(input, "detail"), JsonInput.String(input, "detail"),
JsonInput.Guid(input, "chapter_id"), JsonInput.Guid(input, "chapterId"),
JsonInput.Guid(input, "character_id")), ct), q => q.ToResponse(), "Novel", novelId)); JsonInput.Guid(input, "characterId")), ct);
if (question is null)
{
return new ToolNotFound("Novel", novelId);
}
var displayNumbers = await chapterLabels.ForNovelAsync(novelId, ct);
return question.ToResponse(displayNumbers);
},
RequiresNovelId: true);
yield return new AgentTool( yield return new AgentTool(
"resolve_open_question", "update_open_question",
"Settle a question with what the writer decided. Set append_to_notes to also write " "Revise a question or change what it is attached to. Only the fields you supply change.",
+ "the resolution into the notes of the chapter and character it hangs off.",
new JsonSchemaBuilder() new JsonSchemaBuilder()
.Str("question_id", "Id of the question to resolve.", required: true) .Str("questionId", "Id of the question to update.", required: true)
.Str("resolution", "What was decided.", required: true) .Str("question", "New wording for the question.")
.Bool("append_to_notes", "Also append the resolution to the associated notes.") .Str("detail", "New detail. Pass an empty string to clear it.")
.Str("chapterId", "Attach to this chapter outline.")
.Str("characterId", "Attach to this character.")
.Bool("clearChapter", "Detach from its chapter.")
.Bool("clearCharacter", "Detach from its character.")
.Build(), .Build(),
async (_, input, ct) => async (_, input, ct) =>
{ {
var questionId = JsonInput.RequiredGuid(input, "question_id"); var questionId = JsonInput.RequiredGuid(input, "questionId");
return await OrNotFound(questions.ResolveAsync( var question = await questions.UpdateAsync(
questionId,
new UpdateOpenQuestionRequest(
JsonInput.String(input, "question"),
JsonInput.String(input, "detail"),
JsonInput.Guid(input, "chapterId"),
JsonInput.Guid(input, "characterId"),
JsonInput.Bool(input, "clearChapter") ?? false,
JsonInput.Bool(input, "clearCharacter") ?? false), ct);
if (question is null)
{
return new ToolNotFound("OpenQuestion", questionId);
}
var displayNumbers = await chapterLabels.ForNovelAsync(question.NovelId, ct);
return question.ToResponse(displayNumbers);
});
yield return new AgentTool(
"resolve_open_question",
"Settle a question with what the writer decided. Set appendToNotes to also write "
+ "the resolution into the notes of the chapter and character it hangs off.",
new JsonSchemaBuilder()
.Str("questionId", "Id of the question to resolve.", required: true)
.Str("resolution", "What was decided.", required: true)
.Bool("appendToNotes", "Also append the resolution to the associated notes.")
.Build(),
async (_, input, ct) =>
{
var questionId = JsonInput.RequiredGuid(input, "questionId");
var question = await questions.ResolveAsync(
questionId, questionId,
new ResolveOpenQuestionRequest( new ResolveOpenQuestionRequest(
JsonInput.RequiredString(input, "resolution"), JsonInput.RequiredString(input, "resolution"),
JsonInput.Bool(input, "append_to_notes") ?? false), ct), q => q.ToResponse(), "OpenQuestion", questionId); JsonInput.Bool(input, "appendToNotes") ?? false), ct);
if (question is null)
{
return new ToolNotFound("OpenQuestion", questionId);
}
var displayNumbers = await chapterLabels.ForNovelAsync(question.NovelId, ct);
return question.ToResponse(displayNumbers);
}); });
yield return new AgentTool( yield return new AgentTool(
"reopen_question", "reopen_question",
"Put a resolved question back on the list. Anything already appended to notes stays.", "Put a resolved question back on the list. Anything already appended to notes stays.",
new JsonSchemaBuilder() new JsonSchemaBuilder()
.Str("question_id", "Id of the question to reopen.", required: true) .Str("questionId", "Id of the question to reopen.", required: true)
.Build(), .Build(),
async (_, input, ct) => async (_, input, ct) =>
{ {
var questionId = JsonInput.RequiredGuid(input, "question_id"); var questionId = JsonInput.RequiredGuid(input, "questionId");
return await OrNotFound(questions.ReopenAsync(questionId, ct), q => q.ToResponse(), "OpenQuestion", questionId); var question = await questions.ReopenAsync(questionId, ct);
if (question is null)
{
return new ToolNotFound("OpenQuestion", questionId);
}
var displayNumbers = await chapterLabels.ForNovelAsync(question.NovelId, ct);
return question.ToResponse(displayNumbers);
}); });
yield return new AgentTool( yield return new AgentTool(
"delete_open_question", "delete_open_question",
"Delete a question outright. Resolving is usually better — it keeps the decision.", "Delete a question outright. Resolving is usually better — it keeps the decision.",
new JsonSchemaBuilder() new JsonSchemaBuilder()
.Str("question_id", "Id of the question to delete.", required: true) .Str("questionId", "Id of the question to delete.", required: true)
.Build(), .Build(),
async (_, input, ct) => async (_, input, ct) =>
{ {
var questionId = JsonInput.RequiredGuid(input, "question_id"); var questionId = JsonInput.RequiredGuid(input, "questionId");
return await DeletedOrNotFound(questions.DeleteAsync(questionId, ct), "OpenQuestion", questionId); return await DeletedOrNotFound(questions.DeleteAsync(questionId, ct), "OpenQuestion", questionId);
}); });
} }
private static JsonSchemaBuilder ArcStageSchema() => private static JsonSchemaBuilder ArcStageSchema() =>
new JsonSchemaBuilder() new JsonSchemaBuilder()
.Int("sort_order", "Position in the arc. Appended to the end when omitted.") .Int("sortOrder", "Position in the arc. Appended to the end when omitted.")
.Str("description", "What shifts in the character here, and what it costs them.") .Str("description", "What shifts in the character here, and what it costs them.")
.Str("chapter_id", "The chapter where this stage lands, if it is pinned to one."); .Str("chapterId", "The chapter where this stage lands, if it is pinned to one.");
private static JsonSchemaBuilder CharacterSchema(bool includeName, bool nameRequired) private static JsonSchemaBuilder CharacterSchema(bool includeName, bool nameRequired)
{ {
@@ -667,11 +966,8 @@ public class NovelAgentToolset(
.Str("appearance", "How they look.") .Str("appearance", "How they look.")
.Str("personality", "Temperament, habits, how they treat people.") .Str("personality", "Temperament, habits, how they treat people.")
.Str("backstory", "History that shapes who they are now.") .Str("backstory", "History that shapes who they are now.")
.Str("want", "What they consciously pursue.") .Str("motivation", "What they consciously pursue, weighed against what they actually need.")
.Str("need", "What they actually need, usually at odds with what they want.") .Str("conflict", "The war inside them and what in the world opposes them.")
.Str("internal_conflict", "The war inside them.")
.Str("external_conflict", "What in the world opposes them.")
.Str("arc_summary", "How they change over the course of the book.")
.Str("voice", "Speech patterns and register that make their dialogue theirs.") .Str("voice", "Speech patterns and register that make their dialogue theirs.")
.Str("notes", "Anything else worth recording.") .Str("notes", "Anything else worth recording.")
.StringArray("tags", "Tags for cross-referencing. Replaces the existing tags.") .StringArray("tags", "Tags for cross-referencing. Replaces the existing tags.")
@@ -680,9 +976,9 @@ public class NovelAgentToolset(
private static JsonSchemaBuilder BeatSchema() => private static JsonSchemaBuilder BeatSchema() =>
new JsonSchemaBuilder() new JsonSchemaBuilder()
.Int("sort_order", "Position in the chapter. Appended to the end when omitted.") .Int("sortOrder", "Position in the chapter. Appended to the end when omitted.")
.StringArray("character_ids", "Ids of the characters whose beat this is. Replaces the existing list.") .StringArray("characterIds", "Ids of the characters whose beat this is. Replaces the existing list.")
.Str("what_happened", "The event itself.") .Str("whatHappened", "The event itself.")
.Str("whats_next", "What it sets in motion — the hook into the next beat.") .Str("whatsNext", "What it sets in motion — the hook into the next beat.")
.StringArray("tags", "Tags for cross-referencing. Replaces the existing tags."); .StringArray("tags", "Tags for cross-referencing. Replaces the existing tags.");
} }
+1
View File
@@ -37,6 +37,7 @@ public class BeatEntityTypeConfiguration : IEntityTypeConfiguration<Beat>
{ {
entity.Property(b => b.Title).IsRequired().HasMaxLength(200); entity.Property(b => b.Title).IsRequired().HasMaxLength(200);
entity.HasIndex(b => new { b.ChapterId, b.SortOrder }); entity.HasIndex(b => new { b.ChapterId, b.SortOrder });
entity.HasQueryFilter(b => b.Chapter!.DeletedAt == null);
entity.HasOne(b => b.Chapter).WithMany(c => c.Beats) entity.HasOne(b => b.Chapter).WithMany(c => c.Beats)
.HasForeignKey(b => b.ChapterId).OnDelete(DeleteBehavior.Cascade); .HasForeignKey(b => b.ChapterId).OnDelete(DeleteBehavior.Cascade);
+4 -2
View File
@@ -81,6 +81,7 @@ public record CharacterBeatResponse(
Guid ChapterId, Guid ChapterId,
int ChapterNumber, int ChapterNumber,
string ChapterTitle, string ChapterTitle,
string ChapterLabel,
int SortOrder, int SortOrder,
string Title, string Title,
string? WhatHappened, string? WhatHappened,
@@ -145,17 +146,18 @@ public static class BeatMapping
b.ChapterId, b.ChapterId,
b.SortOrder, b.SortOrder,
b.Title, b.Title,
[.. b.Characters.OrderBy(c => c.Name).Select(c => new BeatCharacterResponse(c.Id, c.Name))], [.. b.Characters.Where(c => c.DeletedAt is null).OrderBy(c => c.Name).Select(c => new BeatCharacterResponse(c.Id, c.Name))],
b.WhatHappened, b.WhatHappened,
b.WhatsNext, b.WhatsNext,
[.. b.Tags.OrderBy(t => t.Name).Select(t => t.ToResponse())], [.. b.Tags.OrderBy(t => t.Name).Select(t => t.ToResponse())],
b.UpdatedAt); b.UpdatedAt);
public static CharacterBeatResponse ToCharacterBeatResponse(this Beat b, Guid characterId) => new( public static CharacterBeatResponse ToCharacterBeatResponse(this Beat b, Guid characterId, string? chapterLabel = null) => new(
b.Id, b.Id,
b.ChapterId, b.ChapterId,
b.Chapter?.Number ?? 0, b.Chapter?.Number ?? 0,
b.Chapter?.Title ?? "(unknown chapter)", b.Chapter?.Title ?? "(unknown chapter)",
chapterLabel ?? b.Chapter?.Title ?? "(unknown chapter)",
b.SortOrder, b.SortOrder,
b.Title, b.Title,
b.WhatHappened, b.WhatHappened,
+16 -2
View File
@@ -1,3 +1,4 @@
using Novelly.Api.Chapters;
using Novelly.Api.Common; using Novelly.Api.Common;
using Novelly.Api.Common.Validation; using Novelly.Api.Common.Validation;
@@ -45,8 +46,21 @@ public static class BeatEndpoints
.WithSummary("Move one or more beats to another chapter, appending them to its end."); .WithSummary("Move one or more beats to another chapter, appending them to its end.");
app.MapGet("/api/characters/{characterId:guid}/beats", async ( app.MapGet("/api/characters/{characterId:guid}/beats", async (
Guid characterId, BeatService service, CancellationToken ct) => Guid characterId, BeatService service, ChapterDisplayNumberLookup chapterLabels, CancellationToken ct) =>
(await service.ListForCharacterAsync(characterId, ct))?.Select(b => b.ToCharacterBeatResponse(characterId)).ToList().ToApiResult()) {
var characterBeats = await service.ListForCharacterAsync(characterId, ct);
if (characterBeats is null)
{
return Results.NotFound();
}
var displayNumbers = characterBeats.Count > 0
? await chapterLabels.ForNovelAsync(characterBeats[0].Chapter!.NovelId, ct)
: new Dictionary<Guid, int>();
return Results.Ok(characterBeats.Select(b =>
b.ToCharacterBeatResponse(characterId, b.Chapter is null ? null : chapterLabels.LabelFor(b.Chapter, displayNumbers))).ToList());
})
.WithTags("Beats") .WithTags("Beats")
.WithSummary("Every beat this character appears in, in manuscript order."); .WithSummary("Every beat this character appears in, in manuscript order.");
+11 -3
View File
@@ -1,4 +1,5 @@
using Microsoft.EntityFrameworkCore; using Microsoft.EntityFrameworkCore;
using Novelly.Api.Activity;
using Novelly.Api.Chapters; using Novelly.Api.Chapters;
using Novelly.Api.Characters; using Novelly.Api.Characters;
using Novelly.Api.Common; using Novelly.Api.Common;
@@ -13,6 +14,7 @@ public class BeatService(
INovelDbContext db, INovelDbContext db,
NovelAccessService access, NovelAccessService access,
TagService tags, TagService tags,
ActivityLog activity,
ILogger<BeatService> logger, ILogger<BeatService> logger,
IModelValidator<CreateBeatRequest> createValidator, IModelValidator<CreateBeatRequest> createValidator,
IModelValidator<UpdateBeatRequest> updateValidator, IModelValidator<UpdateBeatRequest> updateValidator,
@@ -68,7 +70,7 @@ public class BeatService(
var beats = await db.Beats var beats = await db.Beats
.Include(b => b.Chapter) .Include(b => b.Chapter)
.Include(b => b.ArcStages) .Include(b => b.ArcStages.Where(s => s.Character!.DeletedAt == null))
.Where(b => b.Characters.Any(c => c.Id == characterId)) .Where(b => b.Characters.Any(c => c.Id == characterId))
.ToListAsync(ct); .ToListAsync(ct);
@@ -119,6 +121,7 @@ public class BeatService(
chapter.UpdatedAt = DateTimeOffset.UtcNow; chapter.UpdatedAt = DateTimeOffset.UtcNow;
db.Beats.Add(beat); db.Beats.Add(beat);
activity.Record(chapter.NovelId, ActivityEntityKind.Beat, ActivityAction.Created, beat.Id);
await db.SaveChangesAsync(ct); await db.SaveChangesAsync(ct);
return (await FindAsync(beat.Id, ct))!; return (await FindAsync(beat.Id, ct))!;
@@ -164,6 +167,7 @@ public class BeatService(
beat.Tags = await tags.ResolveAsync(chapter.NovelId, names, ct); beat.Tags = await tags.ResolveAsync(chapter.NovelId, names, ct);
} }
activity.Record(chapter.NovelId, ActivityEntityKind.Beat, ActivityAction.Updated, beat.Id);
await db.SaveChangesAsync(ct); await db.SaveChangesAsync(ct);
return (await FindAsync(id, ct))!; return (await FindAsync(id, ct))!;
} }
@@ -183,7 +187,11 @@ public class BeatService(
await RequireBeatAccessAsync(beat, NovelPermission.DeleteContent, ct); await RequireBeatAccessAsync(beat, NovelPermission.DeleteContent, ct);
var chapter = await db.Chapters.FirstOrDefaultAsync(c => c.Id == beat.ChapterId, ct); var chapter = await db.Chapters.FirstOrDefaultAsync(c => c.Id == beat.ChapterId, ct);
if (chapter is not null) chapter.UpdatedAt = DateTimeOffset.UtcNow; if (chapter is not null)
{
chapter.UpdatedAt = DateTimeOffset.UtcNow;
activity.Record(chapter.NovelId, ActivityEntityKind.Beat, ActivityAction.Deleted, beat.Id);
}
db.Beats.Remove(beat); db.Beats.Remove(beat);
await db.SaveChangesAsync(ct); await db.SaveChangesAsync(ct);
@@ -387,7 +395,7 @@ public class BeatService(
private IQueryable<Beat> Query() => private IQueryable<Beat> Query() =>
db.Beats db.Beats
.Include(b => b.Characters) .Include(b => b.Characters.Where(c => c.DeletedAt == null))
.Include(b => b.Tags); .Include(b => b.Tags);
private async Task<Beat?> FindAsync(Guid id, CancellationToken ct) private async Task<Beat?> FindAsync(Guid id, CancellationToken ct)
+6 -1
View File
@@ -8,7 +8,7 @@ using Novelly.Api.Tags;
namespace Novelly.Api.Chapters; namespace Novelly.Api.Chapters;
public class Chapter public class Chapter : ISoftDeletable
{ {
public Guid Id { get; set; } = Guid.NewGuid(); public Guid Id { get; set; } = Guid.NewGuid();
public Guid NovelId { get; set; } public Guid NovelId { get; set; }
@@ -16,6 +16,8 @@ public class Chapter
public int Number { get; set; } public int Number { get; set; }
public ChapterKind Kind { get; set; } = ChapterKind.Body;
public string Title { get; set; } = string.Empty; public string Title { get; set; } = string.Empty;
public string? Summary { get; set; } public string? Summary { get; set; }
@@ -31,6 +33,7 @@ public class Chapter
public DateTimeOffset CreatedAt { get; set; } = DateTimeOffset.UtcNow; public DateTimeOffset CreatedAt { get; set; } = DateTimeOffset.UtcNow;
public DateTimeOffset UpdatedAt { get; set; } = DateTimeOffset.UtcNow; public DateTimeOffset UpdatedAt { get; set; } = DateTimeOffset.UtcNow;
public DateTimeOffset? DeletedAt { get; set; }
public List<Beat> Beats { get; set; } = []; public List<Beat> Beats { get; set; } = [];
@@ -44,6 +47,8 @@ public class ChapterEntityTypeConfiguration : IEntityTypeConfiguration<Chapter>
{ {
entity.Property(c => c.Title).IsRequired().HasMaxLength(300); entity.Property(c => c.Title).IsRequired().HasMaxLength(300);
entity.Property(c => c.Status).HasConversion<string>().HasMaxLength(32); entity.Property(c => c.Status).HasConversion<string>().HasMaxLength(32);
entity.Property(c => c.Kind).HasConversion<string>().HasMaxLength(32);
entity.HasIndex(c => new { c.NovelId, c.Number }); entity.HasIndex(c => new { c.NovelId, c.Number });
entity.HasQueryFilter(c => c.DeletedAt == null);
} }
} }
+12 -6
View File
@@ -10,6 +10,8 @@ public record ChapterSummaryResponse(
Guid Id, Guid Id,
Guid NovelId, Guid NovelId,
int Number, int Number,
ChapterKind Kind,
int? DisplayNumber,
string Title, string Title,
string? Summary, string? Summary,
IReadOnlyList<LocationResponse> Locations, IReadOnlyList<LocationResponse> Locations,
@@ -24,6 +26,8 @@ public record ChapterResponse(
Guid Id, Guid Id,
Guid NovelId, Guid NovelId,
int Number, int Number,
ChapterKind Kind,
int? DisplayNumber,
string Title, string Title,
string? Summary, string? Summary,
IReadOnlyList<LocationResponse> Locations, IReadOnlyList<LocationResponse> Locations,
@@ -39,6 +43,7 @@ public record ChapterResponse(
public record CreateChapterRequest( public record CreateChapterRequest(
string Title, string Title,
int? Number = null, int? Number = null,
ChapterKind Kind = ChapterKind.Body,
string? Summary = null, string? Summary = null,
IReadOnlyList<string>? Locations = null, IReadOnlyList<string>? Locations = null,
string? Notes = null, string? Notes = null,
@@ -63,6 +68,7 @@ public class CreateChapterRequestValidator : IModelValidator<CreateChapterReques
public record UpdateChapterRequest( public record UpdateChapterRequest(
string? Title = null, string? Title = null,
int? Number = null, int? Number = null,
ChapterKind? Kind = null,
string? Summary = null, string? Summary = null,
IReadOnlyList<string>? Locations = null, IReadOnlyList<string>? Locations = null,
string? Notes = null, string? Notes = null,
@@ -115,9 +121,9 @@ file static class ChapterValidation
public static class ChapterMapping public static class ChapterMapping
{ {
public static ChapterResponse ToResponse(this Chapter c) => new( public static ChapterResponse ToResponse(this Chapter c, int? displayNumber = null) => new(
c.Id, c.NovelId, c.Number, c.Title, c.Summary, c.Id, c.NovelId, c.Number, c.Kind, displayNumber, c.Title, c.Summary,
[.. c.Locations.OrderBy(l => l.Name).Select(l => l.ToResponse())], [.. c.Locations.Where(l => l.DeletedAt is null).OrderBy(l => l.Name).Select(l => l.ToResponse())],
c.Notes, c.Notes,
c.Status, c.TargetWordCount, c.Status, c.TargetWordCount,
[.. c.Beats.OrderBy(b => b.SortOrder).Select(b => b.ToResponse())], [.. c.Beats.OrderBy(b => b.SortOrder).Select(b => b.ToResponse())],
@@ -125,9 +131,9 @@ public static class ChapterMapping
[.. c.Tags.OrderBy(t => t.Name).Select(t => t.ToResponse())], [.. c.Tags.OrderBy(t => t.Name).Select(t => t.ToResponse())],
c.UpdatedAt); c.UpdatedAt);
public static ChapterSummaryResponse ToSummaryResponse(this Chapter c) => new( public static ChapterSummaryResponse ToSummaryResponse(this Chapter c, int? displayNumber = null) => new(
c.Id, c.NovelId, c.Number, c.Title, c.Summary, c.Id, c.NovelId, c.Number, c.Kind, displayNumber, c.Title, c.Summary,
[.. c.Locations.OrderBy(l => l.Name).Select(l => l.ToResponse())], [.. c.Locations.Where(l => l.DeletedAt is null).OrderBy(l => l.Name).Select(l => l.ToResponse())],
c.Status, c.TargetWordCount, c.Status, c.TargetWordCount,
c.Beats.Count, c.WordCount, c.Beats.Count, c.WordCount,
[.. c.Tags.OrderBy(t => t.Name).Select(t => t.ToResponse())], [.. c.Tags.OrderBy(t => t.Name).Select(t => t.ToResponse())],
@@ -0,0 +1,38 @@
using Microsoft.EntityFrameworkCore;
using Novelly.Api.Data;
namespace Novelly.Api.Chapters;
public class ChapterDisplayNumberLookup(INovelDbContext db)
{
public async Task<IReadOnlyDictionary<Guid, int>> ForNovelAsync(Guid novelId, CancellationToken ct = default)
{
var chapters = await db.Chapters.AsNoTracking().Where(c => c.NovelId == novelId).ToListAsync(ct);
return ChapterNumbering.DisplayNumbers(chapters);
}
public async Task<int?> ForChapterAsync(Chapter chapter, CancellationToken ct = default)
{
if (chapter.Kind != ChapterKind.Body)
return null;
return await db.Chapters.CountAsync(
c => c.NovelId == chapter.NovelId && c.Kind == ChapterKind.Body && c.Number <= chapter.Number, ct);
}
public async Task<IReadOnlyDictionary<Guid, int>> ForChaptersAsync(IEnumerable<Chapter> chapters, CancellationToken ct = default)
{
var displayNumbers = new Dictionary<Guid, int>();
foreach (var chapter in chapters.DistinctBy(c => c.Id))
{
if (await ForChapterAsync(chapter, ct) is { } number)
displayNumbers[chapter.Id] = number;
}
return displayNumbers;
}
public string LabelFor(Chapter chapter, IReadOnlyDictionary<Guid, int> displayNumbers) =>
ChapterNumbering.Label(chapter.Kind, displayNumbers.TryGetValue(chapter.Id, out var n) ? n : null, chapter.Title);
}
+29 -5
View File
@@ -12,7 +12,12 @@ public static class ChapterEndpoints
.AddEndpointFilter<ValidationEndpointFilter>(); .AddEndpointFilter<ValidationEndpointFilter>();
novelScoped.MapGet("/", async (Guid novelId, ChapterService service, CancellationToken ct) => novelScoped.MapGet("/", async (Guid novelId, ChapterService service, CancellationToken ct) =>
Results.Ok((await service.ListAsync(novelId, ct)).Select(c => c.ToSummaryResponse()))) {
var chapters = await service.ListAsync(novelId, ct);
var displayNumbers = ChapterNumbering.DisplayNumbers(chapters);
return Results.Ok(chapters.Select(c =>
c.ToSummaryResponse(displayNumbers.TryGetValue(c.Id, out var n) ? n : null)));
})
.WithSummary("List a novel's chapters in manuscript order."); .WithSummary("List a novel's chapters in manuscript order.");
novelScoped.MapPost("/", async ( novelScoped.MapPost("/", async (
@@ -24,7 +29,8 @@ public static class ChapterEndpoints
return Results.NotFound(); return Results.NotFound();
} }
var created = chapter.ToResponse(); var displayNumber = await service.DisplayNumberAsync(chapter, ct);
var created = chapter.ToResponse(displayNumber);
return Results.Created($"/api/chapters/{created.Id}", created); return Results.Created($"/api/chapters/{created.Id}", created);
}) })
.WithSummary("Add a chapter."); .WithSummary("Add a chapter.");
@@ -34,17 +40,35 @@ public static class ChapterEndpoints
.AddEndpointFilter<ValidationEndpointFilter>(); .AddEndpointFilter<ValidationEndpointFilter>();
chapters.MapGet("/{id:guid}", async (Guid id, ChapterService service, CancellationToken ct) => chapters.MapGet("/{id:guid}", async (Guid id, ChapterService service, CancellationToken ct) =>
(await service.GetAsync(id, ct))?.ToResponse().ToApiResult()) {
var chapter = await service.GetAsync(id, ct);
if (chapter is null)
{
return Results.NotFound();
}
var displayNumber = await service.DisplayNumberAsync(chapter, ct);
return chapter.ToResponse(displayNumber).ToApiResult();
})
.WithSummary("Read a chapter with its beats and prose."); .WithSummary("Read a chapter with its beats and prose.");
chapters.MapPatch("/{id:guid}", async ( chapters.MapPatch("/{id:guid}", async (
Guid id, UpdateChapterRequest request, ChapterService service, CancellationToken ct) => Guid id, UpdateChapterRequest request, ChapterService service, CancellationToken ct) =>
(await service.UpdateAsync(id, request, ct))?.ToResponse().ToApiResult()) {
var chapter = await service.UpdateAsync(id, request, ct);
if (chapter is null)
{
return Results.NotFound();
}
var displayNumber = await service.DisplayNumberAsync(chapter, ct);
return chapter.ToResponse(displayNumber).ToApiResult();
})
.WithSummary("Update a chapter."); .WithSummary("Update a chapter.");
chapters.MapDelete("/{id:guid}", async (Guid id, ChapterService service, CancellationToken ct) => chapters.MapDelete("/{id:guid}", async (Guid id, ChapterService service, CancellationToken ct) =>
await service.DeleteAsync(id, ct) ? Results.NoContent() : Results.NotFound()) await service.DeleteAsync(id, ct) ? Results.NoContent() : Results.NotFound())
.WithSummary("Delete a chapter."); .WithSummary("Move a chapter to the trash.");
return app; return app;
} }
+8
View File
@@ -0,0 +1,8 @@
namespace Novelly.Api.Chapters;
public enum ChapterKind
{
FrontMatter,
Body,
BackMatter
}
@@ -0,0 +1,25 @@
namespace Novelly.Api.Chapters;
public static class ChapterNumbering
{
public static IReadOnlyDictionary<Guid, int> DisplayNumbers(IEnumerable<Chapter> novelChapters)
{
var displayNumbers = new Dictionary<Guid, int>();
var next = 1;
foreach (var chapter in novelChapters.OrderBy(c => c.Number))
{
if (chapter.Kind != ChapterKind.Body)
continue;
displayNumbers[chapter.Id] = next++;
}
return displayNumbers;
}
public static string Label(ChapterKind kind, int? displayNumber, string title) =>
kind == ChapterKind.Body && displayNumber is { } number
? $"Chapter {number}: {title}"
: title;
}
+21 -6
View File
@@ -1,4 +1,5 @@
using Microsoft.EntityFrameworkCore; using Microsoft.EntityFrameworkCore;
using Novelly.Api.Activity;
using Novelly.Api.Common; using Novelly.Api.Common;
using Novelly.Api.Common.Validation; using Novelly.Api.Common.Validation;
using Novelly.Api.Data; using Novelly.Api.Data;
@@ -13,6 +14,8 @@ public class ChapterService(
NovelAccessService access, NovelAccessService access,
TagService tags, TagService tags,
LocationService locations, LocationService locations,
ChapterDisplayNumberLookup displayNumbers,
ActivityLog activity,
ILogger<ChapterService> logger, ILogger<ChapterService> logger,
IModelValidator<CreateChapterRequest> createValidator, IModelValidator<CreateChapterRequest> createValidator,
IModelValidator<UpdateChapterRequest> updateValidator) IModelValidator<UpdateChapterRequest> updateValidator)
@@ -28,7 +31,7 @@ public class ChapterService(
return await db.Chapters return await db.Chapters
.Include(c => c.Beats) .Include(c => c.Beats)
.Include(c => c.Tags) .Include(c => c.Tags)
.Include(c => c.Locations) .Include(c => c.Locations.Where(l => l.DeletedAt == null))
.Where(c => c.NovelId == novelId) .Where(c => c.NovelId == novelId)
.OrderBy(c => c.Number) .OrderBy(c => c.Number)
.ToListAsync(ct); .ToListAsync(ct);
@@ -71,6 +74,7 @@ public class ChapterService(
NovelId = novelId, NovelId = novelId,
Title = request.Title, Title = request.Title,
Number = request.Number ?? await NextChapterNumberAsync(novelId, ct), Number = request.Number ?? await NextChapterNumberAsync(novelId, ct),
Kind = request.Kind,
Summary = request.Summary, Summary = request.Summary,
Notes = request.Notes, Notes = request.Notes,
Status = request.Status, Status = request.Status,
@@ -90,6 +94,7 @@ public class ChapterService(
} }
db.Chapters.Add(chapter); db.Chapters.Add(chapter);
activity.Record(novelId, ActivityEntityKind.Chapter, ActivityAction.Created, chapter.Id, chapter.WordCount);
await db.SaveChangesAsync(ct); await db.SaveChangesAsync(ct);
return (await FindAsync(chapter.Id, ct))!; return (await FindAsync(chapter.Id, ct))!;
@@ -113,11 +118,14 @@ public class ChapterService(
chapter.Title = Patch.Apply(chapter.Title, request.Title) ?? chapter.Title; chapter.Title = Patch.Apply(chapter.Title, request.Title) ?? chapter.Title;
chapter.Number = request.Number ?? chapter.Number; chapter.Number = request.Number ?? chapter.Number;
chapter.Kind = request.Kind ?? chapter.Kind;
chapter.Summary = Patch.Apply(chapter.Summary, request.Summary); chapter.Summary = Patch.Apply(chapter.Summary, request.Summary);
chapter.Notes = Patch.Apply(chapter.Notes, request.Notes); chapter.Notes = Patch.Apply(chapter.Notes, request.Notes);
chapter.Status = request.Status ?? chapter.Status; chapter.Status = request.Status ?? chapter.Status;
chapter.TargetWordCount = request.TargetWordCount ?? chapter.TargetWordCount; chapter.TargetWordCount = request.TargetWordCount ?? chapter.TargetWordCount;
var wordCountBeforeEdit = chapter.WordCount;
if (request.Prose is not null) if (request.Prose is not null)
{ {
chapter.Prose = Patch.Apply(chapter.Prose, request.Prose); chapter.Prose = Patch.Apply(chapter.Prose, request.Prose);
@@ -136,6 +144,7 @@ public class ChapterService(
chapter.Locations = await locations.ResolveAsync(chapter.NovelId, locationNames, ct); chapter.Locations = await locations.ResolveAsync(chapter.NovelId, locationNames, ct);
} }
activity.Record(chapter.NovelId, ActivityEntityKind.Chapter, ActivityAction.Updated, chapter.Id, chapter.WordCount - wordCountBeforeEdit);
await db.SaveChangesAsync(ct); await db.SaveChangesAsync(ct);
return (await FindAsync(id, ct))!; return (await FindAsync(id, ct))!;
} }
@@ -144,26 +153,32 @@ public class ChapterService(
{ {
Guard.Default(id, nameof(id)); Guard.Default(id, nameof(id));
logger.LogInformation("Deleting chapter {ChapterId}", id); logger.LogInformation("Moving chapter {ChapterId} to trash", id);
var chapter = await FindAsync(id, ct); var chapter = await db.Chapters.FirstOrDefaultAsync(c => c.Id == id, ct);
if (chapter is null) if (chapter is null)
{ {
logger.LogWarning("Chapter {ChapterId} not found", id);
return false; return false;
} }
await access.RequireAsync(chapter.NovelId, NovelPermission.DeleteContent, ct); await access.RequireAsync(chapter.NovelId, NovelPermission.DeleteContent, ct);
db.Chapters.Remove(chapter); chapter.DeletedAt = DateTimeOffset.UtcNow;
activity.Record(chapter.NovelId, ActivityEntityKind.Chapter, ActivityAction.Deleted, chapter.Id, -chapter.WordCount);
await db.SaveChangesAsync(ct); await db.SaveChangesAsync(ct);
return true; return true;
} }
public Task<int?> DisplayNumberAsync(Chapter chapter, CancellationToken ct = default) =>
displayNumbers.ForChapterAsync(chapter, ct);
private async Task<int> NextChapterNumberAsync(Guid novelId, CancellationToken ct) private async Task<int> NextChapterNumberAsync(Guid novelId, CancellationToken ct)
{ {
logger.LogDebug("Computing next chapter number for novel {NovelId}", novelId); logger.LogDebug("Computing next chapter number for novel {NovelId}", novelId);
var max = await db.Chapters var max = await db.Chapters
.IgnoreQueryFilters()
.Where(c => c.NovelId == novelId) .Where(c => c.NovelId == novelId)
.MaxAsync(c => (int?)c.Number, ct); .MaxAsync(c => (int?)c.Number, ct);
@@ -177,10 +192,10 @@ public class ChapterService(
logger.LogDebug("Finding chapter {ChapterId}", id); logger.LogDebug("Finding chapter {ChapterId}", id);
var chapter = await db.Chapters var chapter = await db.Chapters
.Include(c => c.Beats).ThenInclude(b => b.Characters) .Include(c => c.Beats).ThenInclude(b => b.Characters.Where(ch => ch.DeletedAt == null))
.Include(c => c.Beats).ThenInclude(b => b.Tags) .Include(c => c.Beats).ThenInclude(b => b.Tags)
.Include(c => c.Tags) .Include(c => c.Tags)
.Include(c => c.Locations) .Include(c => c.Locations.Where(l => l.DeletedAt == null))
.FirstOrDefaultAsync(c => c.Id == id, ct); .FirstOrDefaultAsync(c => c.Id == id, ct);
if (chapter is null) if (chapter is null)
+8 -8
View File
@@ -2,12 +2,13 @@ using Microsoft.EntityFrameworkCore;
using Microsoft.EntityFrameworkCore.Metadata.Builders; using Microsoft.EntityFrameworkCore.Metadata.Builders;
using Novelly.Api.Beats; using Novelly.Api.Beats;
using Novelly.Api.Chapters; using Novelly.Api.Chapters;
using Novelly.Api.Common;
using Novelly.Api.Novels; using Novelly.Api.Novels;
using Novelly.Api.Tags; using Novelly.Api.Tags;
namespace Novelly.Api.Characters; namespace Novelly.Api.Characters;
public class Character public class Character : ISoftDeletable
{ {
public Guid Id { get; set; } = Guid.NewGuid(); public Guid Id { get; set; } = Guid.NewGuid();
public Guid NovelId { get; set; } public Guid NovelId { get; set; }
@@ -26,14 +27,9 @@ public class Character
public string? Personality { get; set; } public string? Personality { get; set; }
public string? Backstory { get; set; } public string? Backstory { get; set; }
public string? Want { get; set; } public string? Motivation { get; set; }
public string? Need { get; set; } public string? Conflict { get; set; }
public string? InternalConflict { get; set; }
public string? ExternalConflict { get; set; }
public string? ArcSummary { get; set; }
public string? Voice { get; set; } public string? Voice { get; set; }
@@ -51,6 +47,7 @@ public class Character
public DateTimeOffset CreatedAt { get; set; } = DateTimeOffset.UtcNow; public DateTimeOffset CreatedAt { get; set; } = DateTimeOffset.UtcNow;
public DateTimeOffset UpdatedAt { get; set; } = DateTimeOffset.UtcNow; public DateTimeOffset UpdatedAt { get; set; } = DateTimeOffset.UtcNow;
public DateTimeOffset? DeletedAt { get; set; }
public List<CharacterRelationship> Relationships { get; set; } = []; public List<CharacterRelationship> Relationships { get; set; } = [];
public List<Tag> Tags { get; set; } = []; public List<Tag> Tags { get; set; } = [];
@@ -84,6 +81,7 @@ public class CharacterEntityTypeConfiguration : IEntityTypeConfiguration<Charact
entity.Property(c => c.Importance).HasConversion<string>().HasMaxLength(32); entity.Property(c => c.Importance).HasConversion<string>().HasMaxLength(32);
entity.HasIndex(c => c.NovelId); entity.HasIndex(c => c.NovelId);
entity.HasIndex(c => c.SameCharacterAsId); entity.HasIndex(c => c.SameCharacterAsId);
entity.HasQueryFilter(c => c.DeletedAt == null);
entity.HasMany(c => c.Relationships).WithOne(r => r.Character!) entity.HasMany(c => c.Relationships).WithOne(r => r.Character!)
.HasForeignKey(r => r.CharacterId).OnDelete(DeleteBehavior.Cascade); .HasForeignKey(r => r.CharacterId).OnDelete(DeleteBehavior.Cascade);
@@ -107,5 +105,7 @@ public class CharacterRelationshipEntityTypeConfiguration : IEntityTypeConfigura
entity.HasOne(r => r.RelatedCharacter).WithMany() entity.HasOne(r => r.RelatedCharacter).WithMany()
.HasForeignKey(r => r.RelatedCharacterId).OnDelete(DeleteBehavior.Restrict); .HasForeignKey(r => r.RelatedCharacterId).OnDelete(DeleteBehavior.Restrict);
entity.HasQueryFilter(r => r.Character!.DeletedAt == null && r.RelatedCharacter!.DeletedAt == null);
} }
} }
@@ -1,4 +1,5 @@
using Microsoft.EntityFrameworkCore; using Microsoft.EntityFrameworkCore;
using Novelly.Api.Activity;
using Novelly.Api.Common; using Novelly.Api.Common;
using Novelly.Api.Common.Validation; using Novelly.Api.Common.Validation;
using Novelly.Api.Data; using Novelly.Api.Data;
@@ -9,6 +10,7 @@ namespace Novelly.Api.Characters;
public class CharacterArcService( public class CharacterArcService(
INovelDbContext db, INovelDbContext db,
NovelAccessService access, NovelAccessService access,
ActivityLog activity,
ILogger<CharacterArcService> logger, ILogger<CharacterArcService> logger,
IModelValidator<CreateArcStageRequest> createValidator, IModelValidator<CreateArcStageRequest> createValidator,
IModelValidator<UpdateArcStageRequest> updateValidator, IModelValidator<UpdateArcStageRequest> updateValidator,
@@ -76,6 +78,7 @@ public class CharacterArcService(
}; };
db.CharacterArcStages.Add(stage); db.CharacterArcStages.Add(stage);
activity.Record(character.NovelId, ActivityEntityKind.ArcStage, ActivityAction.Created, stage.Id);
await db.SaveChangesAsync(ct); await db.SaveChangesAsync(ct);
return (await FindAsync(stage.Id, ct))!; return (await FindAsync(stage.Id, ct))!;
@@ -112,6 +115,7 @@ public class CharacterArcService(
stage.ChapterId = request.ChapterId ?? stage.ChapterId; stage.ChapterId = request.ChapterId ?? stage.ChapterId;
stage.UpdatedAt = DateTimeOffset.UtcNow; stage.UpdatedAt = DateTimeOffset.UtcNow;
activity.Record(character.NovelId, ActivityEntityKind.ArcStage, ActivityAction.Updated, stage.Id);
await db.SaveChangesAsync(ct); await db.SaveChangesAsync(ct);
return (await FindAsync(id, ct))!; return (await FindAsync(id, ct))!;
} }
@@ -128,9 +132,11 @@ public class CharacterArcService(
return false; return false;
} }
await RequireCharacterAccessAsync(stage.CharacterId, NovelPermission.DeleteContent, ct); var novelId = await db.Characters.Where(c => c.Id == stage.CharacterId).Select(c => c.NovelId).FirstOrDefaultAsync(ct);
await access.RequireAsync(novelId, NovelPermission.DeleteContent, ct);
db.CharacterArcStages.Remove(stage); db.CharacterArcStages.Remove(stage);
activity.Record(novelId, ActivityEntityKind.ArcStage, ActivityAction.Deleted, stage.Id);
await db.SaveChangesAsync(ct); await db.SaveChangesAsync(ct);
return true; return true;
} }
@@ -277,7 +283,7 @@ public class CharacterArcService(
private IQueryable<CharacterArcStage> Query() => private IQueryable<CharacterArcStage> Query() =>
db.CharacterArcStages db.CharacterArcStages
.Include(s => s.Chapter) .Include(s => s.Chapter)
.Include(s => s.Beats).ThenInclude(b => b.Chapter); .Include(s => s.Beats.Where(b => b.Chapter!.DeletedAt == null)).ThenInclude(b => b.Chapter);
private async Task<CharacterArcStage?> FindAsync(Guid id, CancellationToken ct) private async Task<CharacterArcStage?> FindAsync(Guid id, CancellationToken ct)
{ {
@@ -33,6 +33,7 @@ public class CharacterArcStageEntityTypeConfiguration : IEntityTypeConfiguration
{ {
entity.Property(s => s.Title).IsRequired().HasMaxLength(200); entity.Property(s => s.Title).IsRequired().HasMaxLength(200);
entity.HasIndex(s => new { s.CharacterId, s.SortOrder }); entity.HasIndex(s => new { s.CharacterId, s.SortOrder });
entity.HasQueryFilter(s => s.Character!.DeletedAt == null);
entity.HasOne(s => s.Chapter).WithMany() entity.HasOne(s => s.Chapter).WithMany()
.HasForeignKey(s => s.ChapterId).OnDelete(DeleteBehavior.SetNull); .HasForeignKey(s => s.ChapterId).OnDelete(DeleteBehavior.SetNull);
@@ -1,4 +1,5 @@
using Novelly.Api.Beats; using Novelly.Api.Beats;
using Novelly.Api.Chapters;
using Novelly.Api.Common.Validation; using Novelly.Api.Common.Validation;
using Novelly.Api.Tags; using Novelly.Api.Tags;
@@ -16,11 +17,8 @@ public record CharacterResponse(
string? Appearance, string? Appearance,
string? Personality, string? Personality,
string? Backstory, string? Backstory,
string? Want, string? Motivation,
string? Need, string? Conflict,
string? InternalConflict,
string? ExternalConflict,
string? ArcSummary,
string? Voice, string? Voice,
string? Notes, string? Notes,
IReadOnlyList<string> Aliases, IReadOnlyList<string> Aliases,
@@ -28,6 +26,7 @@ public record CharacterResponse(
string? SameCharacterAsName, string? SameCharacterAsName,
Guid? RevealedInChapterId, Guid? RevealedInChapterId,
int? RevealedInChapterNumber, int? RevealedInChapterNumber,
string? RevealedInChapterLabel,
string? IdentityNote, string? IdentityNote,
IReadOnlyList<CharacterIdentityResponse> OtherIdentities, IReadOnlyList<CharacterIdentityResponse> OtherIdentities,
IReadOnlyList<RelationshipResponse> Relationships, IReadOnlyList<RelationshipResponse> Relationships,
@@ -54,11 +53,8 @@ public record CreateCharacterRequest(
string? Appearance = null, string? Appearance = null,
string? Personality = null, string? Personality = null,
string? Backstory = null, string? Backstory = null,
string? Want = null, string? Motivation = null,
string? Need = null, string? Conflict = null,
string? InternalConflict = null,
string? ExternalConflict = null,
string? ArcSummary = null,
string? Voice = null, string? Voice = null,
string? Notes = null, string? Notes = null,
IReadOnlyList<string>? Tags = null, IReadOnlyList<string>? Tags = null,
@@ -73,7 +69,7 @@ public class CreateCharacterRequestValidator : IModelValidator<CreateCharacterRe
result.AddRequiredTextErrors("Name", "Name", model.Name, 200); result.AddRequiredTextErrors("Name", "Name", model.Name, 200);
CharacterValidation.OptionalFields( CharacterValidation.OptionalFields(
model.Age, model.Pronouns, model.Occupation, model.Appearance, model.Personality, model.Backstory, model.Age, model.Pronouns, model.Occupation, model.Appearance, model.Personality, model.Backstory,
model.Want, model.Need, model.InternalConflict, model.ExternalConflict, model.ArcSummary, model.Voice, model.Motivation, model.Conflict, model.Voice,
model.Notes, model.Tags, model.Aliases, result); model.Notes, model.Tags, model.Aliases, result);
return result; return result;
@@ -90,11 +86,8 @@ public record UpdateCharacterRequest(
string? Appearance = null, string? Appearance = null,
string? Personality = null, string? Personality = null,
string? Backstory = null, string? Backstory = null,
string? Want = null, string? Motivation = null,
string? Need = null, string? Conflict = null,
string? InternalConflict = null,
string? ExternalConflict = null,
string? ArcSummary = null,
string? Voice = null, string? Voice = null,
string? Notes = null, string? Notes = null,
IReadOnlyList<string>? Tags = null, IReadOnlyList<string>? Tags = null,
@@ -109,7 +102,7 @@ public class UpdateCharacterRequestValidator : IModelValidator<UpdateCharacterRe
result.AddUnclearableTextErrors("Name", "Name", model.Name, "a character", 200); result.AddUnclearableTextErrors("Name", "Name", model.Name, "a character", 200);
CharacterValidation.OptionalFields( CharacterValidation.OptionalFields(
model.Age, model.Pronouns, model.Occupation, model.Appearance, model.Personality, model.Backstory, model.Age, model.Pronouns, model.Occupation, model.Appearance, model.Personality, model.Backstory,
model.Want, model.Need, model.InternalConflict, model.ExternalConflict, model.ArcSummary, model.Voice, model.Motivation, model.Conflict, model.Voice,
model.Notes, model.Tags, model.Aliases, result); model.Notes, model.Tags, model.Aliases, result);
return result; return result;
@@ -120,7 +113,7 @@ file static class CharacterValidation
{ {
public static void OptionalFields( public static void OptionalFields(
string? age, string? pronouns, string? occupation, string? appearance, string? personality, string? backstory, string? age, string? pronouns, string? occupation, string? appearance, string? personality, string? backstory,
string? want, string? need, string? internalConflict, string? externalConflict, string? arcSummary, string? voice, string? motivation, string? conflict, string? voice,
string? notes, IReadOnlyList<string>? tags, IReadOnlyList<string>? aliases, ValidationResult result) string? notes, IReadOnlyList<string>? tags, IReadOnlyList<string>? aliases, ValidationResult result)
{ {
Cap(age, "Age", 100, result); Cap(age, "Age", 100, result);
@@ -129,11 +122,8 @@ file static class CharacterValidation
Cap(appearance, "Appearance", 20000, result); Cap(appearance, "Appearance", 20000, result);
Cap(personality, "Personality", 20000, result); Cap(personality, "Personality", 20000, result);
Cap(backstory, "Backstory", 20000, result); Cap(backstory, "Backstory", 20000, result);
Cap(want, "Want", 2000, result); Cap(motivation, "Motivation", 2000, result);
Cap(need, "Need", 2000, result); Cap(conflict, "Conflict", 2000, result);
Cap(internalConflict, "InternalConflict", 2000, result);
Cap(externalConflict, "ExternalConflict", 2000, result);
Cap(arcSummary, "ArcSummary", 20000, result);
Cap(voice, "Voice", 2000, result); Cap(voice, "Voice", 2000, result);
Cap(notes, "Notes", 20000, result); Cap(notes, "Notes", 20000, result);
@@ -212,6 +202,7 @@ public record ArcStageResponse(
Guid? ChapterId, Guid? ChapterId,
int? ChapterNumber, int? ChapterNumber,
string? ChapterTitle, string? ChapterTitle,
string? ChapterLabel,
IReadOnlyList<CharacterBeatResponse> Beats, IReadOnlyList<CharacterBeatResponse> Beats,
DateTimeOffset UpdatedAt); DateTimeOffset UpdatedAt);
@@ -298,39 +289,51 @@ public class SetArcStageBeatsRequestValidator : IModelValidator<SetArcStageBeats
public static class CharacterMapping public static class CharacterMapping
{ {
public static CharacterResponse ToResponse(this Character c) => new( public static CharacterResponse ToResponse(this Character c, IReadOnlyDictionary<Guid, int>? displayNumbers = null) => new(
c.Id, c.NovelId, c.Name, c.Role, c.Importance, c.Age, c.Pronouns, c.Occupation, c.Id, c.NovelId, c.Name, c.Role, c.Importance, c.Age, c.Pronouns, c.Occupation,
c.Appearance, c.Personality, c.Backstory, c.Want, c.Need, c.Appearance, c.Personality, c.Backstory, c.Motivation, c.Conflict, c.Voice, c.Notes,
c.InternalConflict, c.ExternalConflict, c.ArcSummary, c.Voice, c.Notes,
[.. c.Aliases], [.. c.Aliases],
c.SameCharacterAsId, c.SameCharacterAsId,
c.SameCharacterAs?.Name, c.SameCharacterAs is { DeletedAt: null } canonical ? canonical.Name : null,
c.RevealedInChapterId, c.RevealedInChapterId,
c.RevealedInChapter?.Number, c.RevealedInChapter is { DeletedAt: null } revealedInChapter ? revealedInChapter.Number : null,
c.RevealedInChapter is { DeletedAt: null } revealedInChapter2 ? ChapterLabel(revealedInChapter2, displayNumbers) : null,
c.IdentityNote, c.IdentityNote,
[.. c.OtherIdentities.OrderBy(o => o.Name).Select(o => new CharacterIdentityResponse(o.Id, o.Name))], [.. c.OtherIdentities.Where(o => o.DeletedAt is null).OrderBy(o => o.Name).Select(o => new CharacterIdentityResponse(o.Id, o.Name))],
[.. c.Relationships.Select(r => new RelationshipResponse( [.. c.Relationships
.Where(r => r.RelatedCharacter is { DeletedAt: null })
.Select(r => new RelationshipResponse(
r.Id, r.Id,
r.RelatedCharacterId, r.RelatedCharacterId,
r.RelatedCharacter?.Name ?? "(unknown)", r.RelatedCharacter!.Name,
r.RelationshipType, r.RelationshipType,
r.Description))], r.Description))],
[.. c.Tags.OrderBy(t => t.Name).Select(t => t.ToResponse())], [.. c.Tags.OrderBy(t => t.Name).Select(t => t.ToResponse())],
[.. c.ArcStages.OrderBy(s => s.SortOrder).Select(s => s.ToResponse())], [.. c.ArcStages.OrderBy(s => s.SortOrder).Select(s => s.ToResponse(displayNumbers))],
c.UpdatedAt); c.UpdatedAt);
public static ArcStageResponse ToResponse(this CharacterArcStage s) => new( public static ArcStageResponse ToResponse(this CharacterArcStage s, IReadOnlyDictionary<Guid, int>? displayNumbers = null)
{
var chapter = s.Chapter is { DeletedAt: null } ? s.Chapter : null;
return new(
s.Id, s.Id,
s.CharacterId, s.CharacterId,
s.SortOrder, s.SortOrder,
s.Title, s.Title,
s.Result, s.Result,
s.ChapterId, s.ChapterId,
s.Chapter?.Number, chapter?.Number,
s.Chapter?.Title, chapter?.Title,
chapter is not null ? ChapterLabel(chapter, displayNumbers) : null,
[.. s.Beats [.. s.Beats
.OrderBy(b => b.Chapter?.Number ?? 0) .Where(b => b.Chapter is { DeletedAt: null })
.OrderBy(b => b.Chapter!.Number)
.ThenBy(b => b.SortOrder) .ThenBy(b => b.SortOrder)
.Select(b => b.ToCharacterBeatResponse(s.CharacterId))], .Select(b => b.ToCharacterBeatResponse(s.CharacterId, ChapterLabel(b.Chapter!, displayNumbers)))],
s.UpdatedAt); s.UpdatedAt);
} }
private static string ChapterLabel(Chapter chapter, IReadOnlyDictionary<Guid, int>? displayNumbers) =>
ChapterNumbering.Label(chapter.Kind, displayNumbers is not null && displayNumbers.TryGetValue(chapter.Id, out var n) ? n : null, chapter.Title);
}
+155 -25
View File
@@ -1,3 +1,4 @@
using Novelly.Api.Chapters;
using Novelly.Api.Common; using Novelly.Api.Common;
using Novelly.Api.Common.Validation; using Novelly.Api.Common.Validation;
@@ -5,18 +6,57 @@ namespace Novelly.Api.Characters;
public static class CharacterEndpoints public static class CharacterEndpoints
{ {
private static IEnumerable<Chapter> ChaptersOf(Character c)
{
if (c.RevealedInChapter is { } revealed)
{
yield return revealed;
}
foreach (var chapter in c.ArcStages.SelectMany(ChaptersOf))
{
yield return chapter;
}
}
private static IEnumerable<Chapter> ChaptersOf(CharacterArcStage stage)
{
if (stage.Chapter is { } chapter)
{
yield return chapter;
}
foreach (var beat in stage.Beats)
{
if (beat.Chapter is { } beatChapter)
{
yield return beatChapter;
}
}
}
public static IEndpointRouteBuilder MapCharacterEndpoints(this IEndpointRouteBuilder app) public static IEndpointRouteBuilder MapCharacterEndpoints(this IEndpointRouteBuilder app)
{ {
var novelScoped = app.MapGroup("/api/novels/{novelId:guid}/characters").WithTags("Characters") var novelScoped = app.MapGroup("/api/novels/{novelId:guid}/characters").WithTags("Characters")
.AddEndpointFilter<RequestLoggingEndpointFilter>() .AddEndpointFilter<RequestLoggingEndpointFilter>()
.AddEndpointFilter<ValidationEndpointFilter>(); .AddEndpointFilter<ValidationEndpointFilter>();
novelScoped.MapGet("/", async (Guid novelId, CharacterService service, CancellationToken ct) => novelScoped.MapGet("/", async (Guid novelId, CharacterService service, ChapterDisplayNumberLookup chapterLabels, CancellationToken ct) =>
Results.Ok((await service.ListAsync(novelId, ct)).Select(c => c.ToResponse()))) {
var list = await service.ListAsync(novelId, ct);
var responses = new List<CharacterResponse>();
foreach (var character in list)
{
var displayNumbers = await chapterLabels.ForChaptersAsync(ChaptersOf(character), ct);
responses.Add(character.ToResponse(displayNumbers));
}
return Results.Ok(responses);
})
.WithSummary("List a novel's character dossiers."); .WithSummary("List a novel's character dossiers.");
novelScoped.MapPost("/", async ( novelScoped.MapPost("/", async (
Guid novelId, CreateCharacterRequest request, CharacterService service, CancellationToken ct) => Guid novelId, CreateCharacterRequest request, CharacterService service, ChapterDisplayNumberLookup chapterLabels, CancellationToken ct) =>
{ {
var character = await service.CreateAsync(novelId, request, ct); var character = await service.CreateAsync(novelId, request, ct);
if (character is null) if (character is null)
@@ -24,7 +64,8 @@ public static class CharacterEndpoints
return Results.NotFound(); return Results.NotFound();
} }
var created = character.ToResponse(); var displayNumbers = await chapterLabels.ForChaptersAsync(ChaptersOf(character), ct);
var created = character.ToResponse(displayNumbers);
return Results.Created($"/api/characters/{created.Id}", created); return Results.Created($"/api/characters/{created.Id}", created);
}) })
.WithSummary("Add a character dossier."); .WithSummary("Add a character dossier.");
@@ -33,22 +74,49 @@ public static class CharacterEndpoints
.AddEndpointFilter<RequestLoggingEndpointFilter>() .AddEndpointFilter<RequestLoggingEndpointFilter>()
.AddEndpointFilter<ValidationEndpointFilter>(); .AddEndpointFilter<ValidationEndpointFilter>();
characters.MapGet("/{id:guid}", async (Guid id, CharacterService service, CancellationToken ct) => characters.MapGet("/{id:guid}", async (Guid id, CharacterService service, ChapterDisplayNumberLookup chapterLabels, CancellationToken ct) =>
(await service.GetAsync(id, ct))?.ToResponse().ToApiResult()) {
var character = await service.GetAsync(id, ct);
if (character is null)
{
return Results.NotFound();
}
var displayNumbers = await chapterLabels.ForChaptersAsync(ChaptersOf(character), ct);
return character.ToResponse(displayNumbers).ToApiResult();
})
.WithSummary("Read a character dossier."); .WithSummary("Read a character dossier.");
characters.MapPatch("/{id:guid}", async ( characters.MapPatch("/{id:guid}", async (
Guid id, UpdateCharacterRequest request, CharacterService service, CancellationToken ct) => Guid id, UpdateCharacterRequest request, CharacterService service, ChapterDisplayNumberLookup chapterLabels, CancellationToken ct) =>
(await service.UpdateAsync(id, request, ct))?.ToResponse().ToApiResult()) {
var character = await service.UpdateAsync(id, request, ct);
if (character is null)
{
return Results.NotFound();
}
var displayNumbers = await chapterLabels.ForChaptersAsync(ChaptersOf(character), ct);
return character.ToResponse(displayNumbers).ToApiResult();
})
.WithSummary("Update a character dossier."); .WithSummary("Update a character dossier.");
characters.MapDelete("/{id:guid}", async (Guid id, CharacterService service, CancellationToken ct) => characters.MapDelete("/{id:guid}", async (Guid id, CharacterService service, CancellationToken ct) =>
await service.DeleteAsync(id, ct) ? Results.NoContent() : Results.NotFound()) await service.DeleteAsync(id, ct) ? Results.NoContent() : Results.NotFound())
.WithSummary("Delete a character."); .WithSummary("Move a character to the trash.");
characters.MapPost("/{id:guid}/relationships", async ( characters.MapPost("/{id:guid}/relationships", async (
Guid id, CreateRelationshipRequest request, CharacterService service, CancellationToken ct) => Guid id, CreateRelationshipRequest request, CharacterService service, ChapterDisplayNumberLookup chapterLabels, CancellationToken ct) =>
(await service.AddRelationshipAsync(id, request, ct))?.ToResponse().ToApiResult()) {
var character = await service.AddRelationshipAsync(id, request, ct);
if (character is null)
{
return Results.NotFound();
}
var displayNumbers = await chapterLabels.ForChaptersAsync(ChaptersOf(character), ct);
return character.ToResponse(displayNumbers).ToApiResult();
})
.WithSummary("Relate this character to another in the same novel."); .WithSummary("Relate this character to another in the same novel.");
characters.MapDelete("/relationships/{relationshipId:guid}", async ( characters.MapDelete("/relationships/{relationshipId:guid}", async (
@@ -57,8 +125,17 @@ public static class CharacterEndpoints
.WithSummary("Remove a relationship."); .WithSummary("Remove a relationship.");
characters.MapPut("/{id:guid}/identity", async ( characters.MapPut("/{id:guid}/identity", async (
Guid id, LinkCharacterIdentityRequest request, CharacterService service, CancellationToken ct) => Guid id, LinkCharacterIdentityRequest request, CharacterService service, ChapterDisplayNumberLookup chapterLabels, CancellationToken ct) =>
(await service.LinkIdentityAsync(id, request, ct))?.ToResponse().ToApiResult()) {
var character = await service.LinkIdentityAsync(id, request, ct);
if (character is null)
{
return Results.NotFound();
}
var displayNumbers = await chapterLabels.ForChaptersAsync(ChaptersOf(character), ct);
return character.ToResponse(displayNumbers).ToApiResult();
})
.WithSummary("Link this character as another identity of a character in the same novel."); .WithSummary("Link this character as another identity of a character in the same novel.");
characters.MapDelete("/{id:guid}/identity", async ( characters.MapDelete("/{id:guid}/identity", async (
@@ -67,12 +144,22 @@ public static class CharacterEndpoints
.WithSummary("Remove this character's identity link."); .WithSummary("Remove this character's identity link.");
characters.MapGet("/{id:guid}/arc", async ( characters.MapGet("/{id:guid}/arc", async (
Guid id, CharacterArcService service, CancellationToken ct) => Guid id, CharacterArcService service, ChapterDisplayNumberLookup chapterLabels, CancellationToken ct) =>
Results.Ok((await service.ListAsync(id, ct)).Select(s => s.ToResponse()))) {
var stages = await service.ListAsync(id, ct);
var responses = new List<ArcStageResponse>();
foreach (var stage in stages)
{
var displayNumbers = await chapterLabels.ForChaptersAsync(ChaptersOf(stage), ct);
responses.Add(stage.ToResponse(displayNumbers));
}
return Results.Ok(responses);
})
.WithSummary("Read a character's arc: its stages, in order."); .WithSummary("Read a character's arc: its stages, in order.");
characters.MapPost("/{id:guid}/arc", async ( characters.MapPost("/{id:guid}/arc", async (
Guid id, CreateArcStageRequest request, CharacterArcService service, CancellationToken ct) => Guid id, CreateArcStageRequest request, CharacterArcService service, ChapterDisplayNumberLookup chapterLabels, CancellationToken ct) =>
{ {
var stage = await service.CreateAsync(id, request, ct); var stage = await service.CreateAsync(id, request, ct);
if (stage is null) if (stage is null)
@@ -80,27 +167,61 @@ public static class CharacterEndpoints
return Results.NotFound(); return Results.NotFound();
} }
var created = stage.ToResponse(); var displayNumbers = await chapterLabels.ForChaptersAsync(ChaptersOf(stage), ct);
var created = stage.ToResponse(displayNumbers);
return Results.Created($"/api/arc-stages/{created.Id}", created); return Results.Created($"/api/arc-stages/{created.Id}", created);
}) })
.WithSummary("Add a stage to a character's arc."); .WithSummary("Add a stage to a character's arc.");
characters.MapPost("/{id:guid}/arc/reorder", async ( characters.MapPost("/{id:guid}/arc/reorder", async (
Guid id, ReorderArcStagesRequest request, CharacterArcService service, CancellationToken ct) => Guid id, ReorderArcStagesRequest request, CharacterArcService service, ChapterDisplayNumberLookup chapterLabels, CancellationToken ct) =>
(await service.ReorderAsync(id, request, ct))?.Select(s => s.ToResponse()).ToList().ToApiResult()) {
var stages = await service.ReorderAsync(id, request, ct);
if (stages is null)
{
return Results.NotFound();
}
var responses = new List<ArcStageResponse>();
foreach (var stage in stages)
{
var displayNumbers = await chapterLabels.ForChaptersAsync(ChaptersOf(stage), ct);
responses.Add(stage.ToResponse(displayNumbers));
}
return Results.Ok(responses);
})
.WithSummary("Renumber a character's arc to match the order given."); .WithSummary("Renumber a character's arc to match the order given.");
var arcStages = app.MapGroup("/api/arc-stages").WithTags("Characters") var arcStages = app.MapGroup("/api/arc-stages").WithTags("Characters")
.AddEndpointFilter<RequestLoggingEndpointFilter>() .AddEndpointFilter<RequestLoggingEndpointFilter>()
.AddEndpointFilter<ValidationEndpointFilter>(); .AddEndpointFilter<ValidationEndpointFilter>();
arcStages.MapGet("/{id:guid}", async (Guid id, CharacterArcService service, CancellationToken ct) => arcStages.MapGet("/{id:guid}", async (Guid id, CharacterArcService service, ChapterDisplayNumberLookup chapterLabels, CancellationToken ct) =>
(await service.GetAsync(id, ct))?.ToResponse().ToApiResult()) {
var stage = await service.GetAsync(id, ct);
if (stage is null)
{
return Results.NotFound();
}
var displayNumbers = await chapterLabels.ForChaptersAsync(ChaptersOf(stage), ct);
return stage.ToResponse(displayNumbers).ToApiResult();
})
.WithSummary("Read one arc stage."); .WithSummary("Read one arc stage.");
arcStages.MapPatch("/{id:guid}", async ( arcStages.MapPatch("/{id:guid}", async (
Guid id, UpdateArcStageRequest request, CharacterArcService service, CancellationToken ct) => Guid id, UpdateArcStageRequest request, CharacterArcService service, ChapterDisplayNumberLookup chapterLabels, CancellationToken ct) =>
(await service.UpdateAsync(id, request, ct))?.ToResponse().ToApiResult()) {
var stage = await service.UpdateAsync(id, request, ct);
if (stage is null)
{
return Results.NotFound();
}
var displayNumbers = await chapterLabels.ForChaptersAsync(ChaptersOf(stage), ct);
return stage.ToResponse(displayNumbers).ToApiResult();
})
.WithSummary("Update an arc stage."); .WithSummary("Update an arc stage.");
arcStages.MapDelete("/{id:guid}", async (Guid id, CharacterArcService service, CancellationToken ct) => arcStages.MapDelete("/{id:guid}", async (Guid id, CharacterArcService service, CancellationToken ct) =>
@@ -108,8 +229,17 @@ public static class CharacterEndpoints
.WithSummary("Delete an arc stage."); .WithSummary("Delete an arc stage.");
arcStages.MapPost("/{id:guid}/beats", async ( arcStages.MapPost("/{id:guid}/beats", async (
Guid id, SetArcStageBeatsRequest request, CharacterArcService service, CancellationToken ct) => Guid id, SetArcStageBeatsRequest request, CharacterArcService service, ChapterDisplayNumberLookup chapterLabels, CancellationToken ct) =>
(await service.SetBeatsAsync(id, request, ct))?.ToResponse().ToApiResult()) {
var stage = await service.SetBeatsAsync(id, request, ct);
if (stage is null)
{
return Results.NotFound();
}
var displayNumbers = await chapterLabels.ForChaptersAsync(ChaptersOf(stage), ct);
return stage.ToResponse(displayNumbers).ToApiResult();
})
.WithSummary("Set which beats belong to this arc stage, replacing its current set. " .WithSummary("Set which beats belong to this arc stage, replacing its current set. "
+ "A beat moved into this stage leaves any other stage of the same character it was in."); + "A beat moved into this stage leaves any other stage of the same character it was in.");
+12 -13
View File
@@ -1,4 +1,5 @@
using Microsoft.EntityFrameworkCore; using Microsoft.EntityFrameworkCore;
using Novelly.Api.Activity;
using Novelly.Api.Common; using Novelly.Api.Common;
using Novelly.Api.Common.Validation; using Novelly.Api.Common.Validation;
using Novelly.Api.Data; using Novelly.Api.Data;
@@ -11,6 +12,7 @@ public class CharacterService(
INovelDbContext db, INovelDbContext db,
NovelAccessService access, NovelAccessService access,
TagService tags, TagService tags,
ActivityLog activity,
ILogger<CharacterService> logger, ILogger<CharacterService> logger,
IModelValidator<CreateCharacterRequest> createValidator, IModelValidator<CreateCharacterRequest> createValidator,
IModelValidator<UpdateCharacterRequest> updateValidator, IModelValidator<UpdateCharacterRequest> updateValidator,
@@ -84,11 +86,8 @@ public class CharacterService(
Appearance = request.Appearance, Appearance = request.Appearance,
Personality = request.Personality, Personality = request.Personality,
Backstory = request.Backstory, Backstory = request.Backstory,
Want = request.Want, Motivation = request.Motivation,
Need = request.Need, Conflict = request.Conflict,
InternalConflict = request.InternalConflict,
ExternalConflict = request.ExternalConflict,
ArcSummary = request.ArcSummary,
Voice = request.Voice, Voice = request.Voice,
Notes = request.Notes Notes = request.Notes
}; };
@@ -104,6 +103,7 @@ public class CharacterService(
} }
db.Characters.Add(character); db.Characters.Add(character);
activity.Record(novelId, ActivityEntityKind.Character, ActivityAction.Created, character.Id);
await db.SaveChangesAsync(ct); await db.SaveChangesAsync(ct);
return (await FindAsync(character.Id, ct))!; return (await FindAsync(character.Id, ct))!;
@@ -134,11 +134,8 @@ public class CharacterService(
character.Appearance = Patch.Apply(character.Appearance, request.Appearance); character.Appearance = Patch.Apply(character.Appearance, request.Appearance);
character.Personality = Patch.Apply(character.Personality, request.Personality); character.Personality = Patch.Apply(character.Personality, request.Personality);
character.Backstory = Patch.Apply(character.Backstory, request.Backstory); character.Backstory = Patch.Apply(character.Backstory, request.Backstory);
character.Want = Patch.Apply(character.Want, request.Want); character.Motivation = Patch.Apply(character.Motivation, request.Motivation);
character.Need = Patch.Apply(character.Need, request.Need); character.Conflict = Patch.Apply(character.Conflict, request.Conflict);
character.InternalConflict = Patch.Apply(character.InternalConflict, request.InternalConflict);
character.ExternalConflict = Patch.Apply(character.ExternalConflict, request.ExternalConflict);
character.ArcSummary = Patch.Apply(character.ArcSummary, request.ArcSummary);
character.Voice = Patch.Apply(character.Voice, request.Voice); character.Voice = Patch.Apply(character.Voice, request.Voice);
character.Notes = Patch.Apply(character.Notes, request.Notes); character.Notes = Patch.Apply(character.Notes, request.Notes);
character.UpdatedAt = DateTimeOffset.UtcNow; character.UpdatedAt = DateTimeOffset.UtcNow;
@@ -153,6 +150,7 @@ public class CharacterService(
character.Aliases = [.. aliases]; character.Aliases = [.. aliases];
} }
activity.Record(character.NovelId, ActivityEntityKind.Character, ActivityAction.Updated, character.Id);
await db.SaveChangesAsync(ct); await db.SaveChangesAsync(ct);
return (await FindAsync(id, ct))!; return (await FindAsync(id, ct))!;
} }
@@ -161,7 +159,7 @@ public class CharacterService(
{ {
Guard.Default(id, nameof(id)); Guard.Default(id, nameof(id));
logger.LogInformation("Deleting character {CharacterId}", id); logger.LogInformation("Moving character {CharacterId} to trash", id);
var character = await FindAsync(id, ct); var character = await FindAsync(id, ct);
if (character is null) if (character is null)
@@ -171,7 +169,8 @@ public class CharacterService(
await access.RequireAsync(character.NovelId, NovelPermission.DeleteContent, ct); await access.RequireAsync(character.NovelId, NovelPermission.DeleteContent, ct);
db.Characters.Remove(character); character.DeletedAt = DateTimeOffset.UtcNow;
activity.Record(character.NovelId, ActivityEntityKind.Character, ActivityAction.Deleted, character.Id);
await db.SaveChangesAsync(ct); await db.SaveChangesAsync(ct);
return true; return true;
} }
@@ -352,7 +351,7 @@ public class CharacterService(
.Include(c => c.ArcStages) .Include(c => c.ArcStages)
.ThenInclude(s => s.Chapter) .ThenInclude(s => s.Chapter)
.Include(c => c.ArcStages) .Include(c => c.ArcStages)
.ThenInclude(s => s.Beats) .ThenInclude(s => s.Beats.Where(b => b.Chapter!.DeletedAt == null))
.ThenInclude(b => b.Chapter) .ThenInclude(b => b.Chapter)
.Include(c => c.SameCharacterAs) .Include(c => c.SameCharacterAs)
.Include(c => c.OtherIdentities) .Include(c => c.OtherIdentities)
@@ -5,6 +5,7 @@ using Microsoft.AspNetCore.Authentication.Cookies;
using Microsoft.AspNetCore.Authorization; using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Identity; using Microsoft.AspNetCore.Identity;
using Microsoft.EntityFrameworkCore; using Microsoft.EntityFrameworkCore;
using Novelly.Api.Activity;
using Novelly.Api.Agent; using Novelly.Api.Agent;
using Novelly.Api.Beats; using Novelly.Api.Beats;
using Novelly.Api.Chapters; using Novelly.Api.Chapters;
@@ -14,10 +15,13 @@ using Novelly.Api.Data;
using Novelly.Api.Genres; using Novelly.Api.Genres;
using Novelly.Api.Imports; using Novelly.Api.Imports;
using Novelly.Api.Locations; using Novelly.Api.Locations;
using Novelly.Api.Mcp;
using Novelly.Api.Novels; using Novelly.Api.Novels;
using Novelly.Api.Questions; using Novelly.Api.Questions;
using Novelly.Api.Tags; using Novelly.Api.Tags;
using Novelly.Api.Trash;
using Novelly.Api.Users; using Novelly.Api.Users;
using ModelContextProtocol.Protocol;
namespace Novelly.Api.Common; namespace Novelly.Api.Common;
@@ -26,6 +30,8 @@ public static class NovellyServiceRegistration
{ {
public static IServiceCollection AddNovelly(this IServiceCollection services, IConfiguration configuration) public static IServiceCollection AddNovelly(this IServiceCollection services, IConfiguration configuration)
{ {
services.Configure<UiSettingsOptions>(configuration.GetSection(UiSettingsOptions.SectionName));
var connectionString = configuration.GetConnectionString("Novel") var connectionString = configuration.GetConnectionString("Novel")
?? "Data Source=novel.db"; ?? "Data Source=novel.db";
@@ -50,6 +56,8 @@ public static class NovellyServiceRegistration
services.AddHttpContextAccessor(); services.AddHttpContextAccessor();
services.AddScoped<INovelUserContext, NovelUserContext>(); services.AddScoped<INovelUserContext, NovelUserContext>();
services.AddScoped<NovelAccessService>(); services.AddScoped<NovelAccessService>();
services.AddScoped<ActivityLog>();
services.AddScoped<ActivityService>();
services.ConfigureApplicationCookie(options => services.ConfigureApplicationCookie(options =>
{ {
@@ -81,6 +89,7 @@ public static class NovellyServiceRegistration
services.AddScoped<LocationService>(); services.AddScoped<LocationService>();
services.AddScoped<GenreService>(); services.AddScoped<GenreService>();
services.AddScoped<ChapterService>(); services.AddScoped<ChapterService>();
services.AddScoped<ChapterDisplayNumberLookup>();
services.AddScoped<OpenQuestionService>(); services.AddScoped<OpenQuestionService>();
services.AddScoped<NovelAgentToolset>(); services.AddScoped<NovelAgentToolset>();
services.AddScoped<NovelAgentService>(); services.AddScoped<NovelAgentService>();
@@ -88,14 +97,35 @@ public static class NovellyServiceRegistration
services.Configure<AgentOptions>(configuration.GetSection(AgentOptions.SectionName)); services.Configure<AgentOptions>(configuration.GetSection(AgentOptions.SectionName));
services.AddScoped<IAgentModelClient, AnthropicAgentModelClient>(); services.AddScoped<IAgentModelClient, AnthropicAgentModelClient>();
services.Configure<ImportOptions>(configuration.GetSection(ImportOptions.SectionName));
services.AddSingleton(Channel.CreateUnbounded<Guid>()); services.AddSingleton(Channel.CreateUnbounded<Guid>());
services.AddScoped<ImportService>(); services.AddScoped<ImportService>();
services.AddScoped<ImportBrowseService>();
services.AddScoped<ImportZipExtractor>();
services.AddScoped<ImportAgentToolset>(); services.AddScoped<ImportAgentToolset>();
services.AddScoped<ImportAgentService>(); services.AddScoped<ImportAgentService>();
services.AddHostedService<ImportJobRunner>(); services.AddHostedService<ImportJobRunner>();
services.Configure<TrashOptions>(configuration.GetSection(TrashOptions.SectionName));
services.AddScoped<TrashService>();
services.AddSingleton(TimeProvider.System);
services.AddHostedService<TrashPurgeRunner>();
services.AddModelValidatorsFromAssemblyContaining<Program>(); services.AddModelValidatorsFromAssemblyContaining<Program>();
services.AddMcpServer(options => options.ServerInfo = new Implementation { Name = "novelly", Version = "1.0.0" })
.WithHttpTransport()
.WithListToolsHandler((request, ct) =>
{
var toolset = request.Services!.GetRequiredService<NovelAgentToolset>();
return ValueTask.FromResult(new ListToolsResult { Tools = [.. NovelMcpTools.Describe(toolset.Definitions)] });
})
.WithCallToolHandler((request, ct) =>
{
var toolset = request.Services!.GetRequiredService<NovelAgentToolset>();
return new ValueTask<CallToolResult>(NovelMcpTools.CallAsync(toolset, toolset.Definitions, request.Params!, ct));
});
return services; return services;
} }
} }
+6
View File
@@ -0,0 +1,6 @@
namespace Novelly.Api.Common;
public interface ISoftDeletable
{
DateTimeOffset? DeletedAt { get; set; }
}
@@ -0,0 +1,18 @@
using Microsoft.Extensions.Options;
namespace Novelly.Api.Common;
public static class UiSettingsEndpoints
{
public static IEndpointRouteBuilder MapUiSettingsEndpoints(this IEndpointRouteBuilder app)
{
app.MapGet("/api/ui-settings", (IOptions<UiSettingsOptions> options) =>
Results.Ok(new UiSettingsResponse(options.Value.ShowPronouns)))
.WithTags("UiSettings")
.AllowAnonymous();
return app;
}
}
public record UiSettingsResponse(bool ShowPronouns);
@@ -0,0 +1,8 @@
namespace Novelly.Api.Common;
public class UiSettingsOptions
{
public const string SectionName = "UiSettings";
public bool ShowPronouns { get; set; }
}
@@ -0,0 +1,86 @@
using Microsoft.EntityFrameworkCore.Migrations;
#nullable disable
namespace Novelly.Api.Data.Migrations
{
/// <inheritdoc />
public partial class CollapseCharacterMotivationAndConflict : Migration
{
/// <inheritdoc />
protected override void Up(MigrationBuilder migrationBuilder)
{
migrationBuilder.Sql(
"""
UPDATE Characters SET Want = CASE
WHEN Want IS NULL OR Want = '' THEN Need
WHEN Need IS NULL OR Need = '' THEN Want
ELSE Want || char(10) || char(10) || Need
END;
""");
migrationBuilder.Sql(
"""
UPDATE Characters SET InternalConflict = CASE
WHEN InternalConflict IS NULL OR InternalConflict = '' THEN ExternalConflict
WHEN ExternalConflict IS NULL OR ExternalConflict = '' THEN InternalConflict
ELSE InternalConflict || char(10) || char(10) || ExternalConflict
END;
""");
migrationBuilder.DropColumn(
name: "ArcSummary",
table: "Characters");
migrationBuilder.DropColumn(
name: "ExternalConflict",
table: "Characters");
migrationBuilder.DropColumn(
name: "Need",
table: "Characters");
migrationBuilder.RenameColumn(
name: "Want",
table: "Characters",
newName: "Motivation");
migrationBuilder.RenameColumn(
name: "InternalConflict",
table: "Characters",
newName: "Conflict");
}
/// <inheritdoc />
protected override void Down(MigrationBuilder migrationBuilder)
{
migrationBuilder.RenameColumn(
name: "Motivation",
table: "Characters",
newName: "Want");
migrationBuilder.RenameColumn(
name: "Conflict",
table: "Characters",
newName: "InternalConflict");
migrationBuilder.AddColumn<string>(
name: "ArcSummary",
table: "Characters",
type: "TEXT",
nullable: true);
migrationBuilder.AddColumn<string>(
name: "ExternalConflict",
table: "Characters",
type: "TEXT",
nullable: true);
migrationBuilder.AddColumn<string>(
name: "Need",
table: "Characters",
type: "TEXT",
nullable: true);
}
}
}
File diff suppressed because it is too large Load Diff
@@ -0,0 +1,63 @@
using System;
using Microsoft.EntityFrameworkCore.Migrations;
#nullable disable
namespace Novelly.Api.Data.Migrations
{
/// <inheritdoc />
public partial class ActivityEvents : Migration
{
/// <inheritdoc />
protected override void Up(MigrationBuilder migrationBuilder)
{
migrationBuilder.CreateTable(
name: "ActivityEvents",
columns: table => new
{
Id = table.Column<Guid>(type: "TEXT", nullable: false),
NovelId = table.Column<Guid>(type: "TEXT", nullable: false),
UserId = table.Column<Guid>(type: "TEXT", nullable: true),
OccurredAt = table.Column<long>(type: "INTEGER", nullable: false),
DayKey = table.Column<int>(type: "INTEGER", nullable: false),
EntityKind = table.Column<string>(type: "TEXT", maxLength: 32, nullable: false),
Action = table.Column<string>(type: "TEXT", maxLength: 32, nullable: false),
EntityId = table.Column<Guid>(type: "TEXT", nullable: false),
WordDelta = table.Column<int>(type: "INTEGER", nullable: false)
},
constraints: table =>
{
table.PrimaryKey("PK_ActivityEvents", x => x.Id);
table.ForeignKey(
name: "FK_ActivityEvents_AspNetUsers_UserId",
column: x => x.UserId,
principalTable: "AspNetUsers",
principalColumn: "Id",
onDelete: ReferentialAction.SetNull);
table.ForeignKey(
name: "FK_ActivityEvents_Novels_NovelId",
column: x => x.NovelId,
principalTable: "Novels",
principalColumn: "Id",
onDelete: ReferentialAction.Cascade);
});
migrationBuilder.CreateIndex(
name: "IX_ActivityEvents_NovelId_DayKey",
table: "ActivityEvents",
columns: new[] { "NovelId", "DayKey" });
migrationBuilder.CreateIndex(
name: "IX_ActivityEvents_UserId_DayKey",
table: "ActivityEvents",
columns: new[] { "UserId", "DayKey" });
}
/// <inheritdoc />
protected override void Down(MigrationBuilder migrationBuilder)
{
migrationBuilder.DropTable(
name: "ActivityEvents");
}
}
}
File diff suppressed because it is too large Load Diff
@@ -0,0 +1,30 @@
using Microsoft.EntityFrameworkCore.Migrations;
#nullable disable
namespace Novelly.Api.Data.Migrations
{
/// <inheritdoc />
public partial class AddChapterKind : Migration
{
/// <inheritdoc />
protected override void Up(MigrationBuilder migrationBuilder)
{
migrationBuilder.AddColumn<string>(
name: "Kind",
table: "Chapters",
type: "TEXT",
maxLength: 32,
nullable: false,
defaultValue: "Body");
}
/// <inheritdoc />
protected override void Down(MigrationBuilder migrationBuilder)
{
migrationBuilder.DropColumn(
name: "Kind",
table: "Chapters");
}
}
}
File diff suppressed because it is too large Load Diff
@@ -0,0 +1,69 @@
using Microsoft.EntityFrameworkCore.Migrations;
#nullable disable
namespace Novelly.Api.Data.Migrations
{
/// <inheritdoc />
public partial class AddSoftDelete : Migration
{
/// <inheritdoc />
protected override void Up(MigrationBuilder migrationBuilder)
{
migrationBuilder.DropIndex(
name: "IX_Locations_NovelId_Name",
table: "Locations");
migrationBuilder.AddColumn<long>(
name: "DeletedAt",
table: "Locations",
type: "INTEGER",
nullable: true);
migrationBuilder.AddColumn<long>(
name: "DeletedAt",
table: "Characters",
type: "INTEGER",
nullable: true);
migrationBuilder.AddColumn<long>(
name: "DeletedAt",
table: "Chapters",
type: "INTEGER",
nullable: true);
migrationBuilder.CreateIndex(
name: "IX_Locations_NovelId_Name",
table: "Locations",
columns: new[] { "NovelId", "Name" },
unique: true,
filter: "\"DeletedAt\" IS NULL");
}
/// <inheritdoc />
protected override void Down(MigrationBuilder migrationBuilder)
{
migrationBuilder.DropIndex(
name: "IX_Locations_NovelId_Name",
table: "Locations");
migrationBuilder.DropColumn(
name: "DeletedAt",
table: "Locations");
migrationBuilder.DropColumn(
name: "DeletedAt",
table: "Characters");
migrationBuilder.DropColumn(
name: "DeletedAt",
table: "Chapters");
migrationBuilder.CreateIndex(
name: "IX_Locations_NovelId_Name",
table: "Locations",
columns: new[] { "NovelId", "Name" },
unique: true);
}
}
}
@@ -169,6 +169,49 @@ namespace Novelly.Api.Data.Migrations
b.ToTable("AspNetUserTokens", (string)null); b.ToTable("AspNetUserTokens", (string)null);
}); });
modelBuilder.Entity("Novelly.Api.Activity.ActivityEvent", b =>
{
b.Property<Guid>("Id")
.ValueGeneratedOnAdd()
.HasColumnType("TEXT");
b.Property<string>("Action")
.IsRequired()
.HasMaxLength(32)
.HasColumnType("TEXT");
b.Property<int>("DayKey")
.HasColumnType("INTEGER");
b.Property<Guid>("EntityId")
.HasColumnType("TEXT");
b.Property<string>("EntityKind")
.IsRequired()
.HasMaxLength(32)
.HasColumnType("TEXT");
b.Property<Guid>("NovelId")
.HasColumnType("TEXT");
b.Property<long>("OccurredAt")
.HasColumnType("INTEGER");
b.Property<Guid?>("UserId")
.HasColumnType("TEXT");
b.Property<int>("WordDelta")
.HasColumnType("INTEGER");
b.HasKey("Id");
b.HasIndex("NovelId", "DayKey");
b.HasIndex("UserId", "DayKey");
b.ToTable("ActivityEvents");
});
modelBuilder.Entity("Novelly.Api.Agent.AgentConversation", b => modelBuilder.Entity("Novelly.Api.Agent.AgentConversation", b =>
{ {
b.Property<Guid>("Id") b.Property<Guid>("Id")
@@ -276,6 +319,14 @@ namespace Novelly.Api.Data.Migrations
b.Property<long>("CreatedAt") b.Property<long>("CreatedAt")
.HasColumnType("INTEGER"); .HasColumnType("INTEGER");
b.Property<long?>("DeletedAt")
.HasColumnType("INTEGER");
b.Property<string>("Kind")
.IsRequired()
.HasMaxLength(32)
.HasColumnType("TEXT");
b.Property<string>("Notes") b.Property<string>("Notes")
.HasColumnType("TEXT"); .HasColumnType("TEXT");
@@ -333,17 +384,17 @@ namespace Novelly.Api.Data.Migrations
b.Property<string>("Appearance") b.Property<string>("Appearance")
.HasColumnType("TEXT"); .HasColumnType("TEXT");
b.Property<string>("ArcSummary") b.Property<string>("Backstory")
.HasColumnType("TEXT"); .HasColumnType("TEXT");
b.Property<string>("Backstory") b.Property<string>("Conflict")
.HasColumnType("TEXT"); .HasColumnType("TEXT");
b.Property<long>("CreatedAt") b.Property<long>("CreatedAt")
.HasColumnType("INTEGER"); .HasColumnType("INTEGER");
b.Property<string>("ExternalConflict") b.Property<long?>("DeletedAt")
.HasColumnType("TEXT"); .HasColumnType("INTEGER");
b.Property<string>("IdentityNote") b.Property<string>("IdentityNote")
.HasColumnType("TEXT"); .HasColumnType("TEXT");
@@ -353,7 +404,7 @@ namespace Novelly.Api.Data.Migrations
.HasMaxLength(32) .HasMaxLength(32)
.HasColumnType("TEXT"); .HasColumnType("TEXT");
b.Property<string>("InternalConflict") b.Property<string>("Motivation")
.HasColumnType("TEXT"); .HasColumnType("TEXT");
b.Property<string>("Name") b.Property<string>("Name")
@@ -361,9 +412,6 @@ namespace Novelly.Api.Data.Migrations
.HasMaxLength(200) .HasMaxLength(200)
.HasColumnType("TEXT"); .HasColumnType("TEXT");
b.Property<string>("Need")
.HasColumnType("TEXT");
b.Property<string>("Notes") b.Property<string>("Notes")
.HasColumnType("TEXT"); .HasColumnType("TEXT");
@@ -396,9 +444,6 @@ namespace Novelly.Api.Data.Migrations
b.Property<string>("Voice") b.Property<string>("Voice")
.HasColumnType("TEXT"); .HasColumnType("TEXT");
b.Property<string>("Want")
.HasColumnType("TEXT");
b.HasKey("Id"); b.HasKey("Id");
b.HasIndex("NovelId"); b.HasIndex("NovelId");
@@ -641,6 +686,9 @@ namespace Novelly.Api.Data.Migrations
b.Property<long>("CreatedAt") b.Property<long>("CreatedAt")
.HasColumnType("INTEGER"); .HasColumnType("INTEGER");
b.Property<long?>("DeletedAt")
.HasColumnType("INTEGER");
b.Property<string>("Name") b.Property<string>("Name")
.IsRequired() .IsRequired()
.HasMaxLength(120) .HasMaxLength(120)
@@ -652,7 +700,8 @@ namespace Novelly.Api.Data.Migrations
b.HasKey("Id"); b.HasKey("Id");
b.HasIndex("NovelId", "Name") b.HasIndex("NovelId", "Name")
.IsUnique(); .IsUnique()
.HasFilter("\"DeletedAt\" IS NULL");
b.ToTable("Locations"); b.ToTable("Locations");
}); });
@@ -1010,6 +1059,24 @@ namespace Novelly.Api.Data.Migrations
.IsRequired(); .IsRequired();
}); });
modelBuilder.Entity("Novelly.Api.Activity.ActivityEvent", b =>
{
b.HasOne("Novelly.Api.Novels.Novel", "Novel")
.WithMany()
.HasForeignKey("NovelId")
.OnDelete(DeleteBehavior.Cascade)
.IsRequired();
b.HasOne("Novelly.Api.Users.NovellyUser", "User")
.WithMany()
.HasForeignKey("UserId")
.OnDelete(DeleteBehavior.SetNull);
b.Navigation("Novel");
b.Navigation("User");
});
modelBuilder.Entity("Novelly.Api.Agent.AgentConversation", b => modelBuilder.Entity("Novelly.Api.Agent.AgentConversation", b =>
{ {
b.HasOne("Novelly.Api.Novels.Novel", "Novel") b.HasOne("Novelly.Api.Novels.Novel", "Novel")
+3
View File
@@ -1,6 +1,7 @@
using Microsoft.AspNetCore.Identity.EntityFrameworkCore; using Microsoft.AspNetCore.Identity.EntityFrameworkCore;
using Microsoft.EntityFrameworkCore.Storage.ValueConversion; using Microsoft.EntityFrameworkCore.Storage.ValueConversion;
using Microsoft.EntityFrameworkCore; using Microsoft.EntityFrameworkCore;
using Novelly.Api.Activity;
using Novelly.Api.Agent; using Novelly.Api.Agent;
using Novelly.Api.Beats; using Novelly.Api.Beats;
using Novelly.Api.Chapters; using Novelly.Api.Chapters;
@@ -33,6 +34,7 @@ public class NovelDbContext(DbContextOptions<NovelDbContext> options) : Identity
public DbSet<ImportJob> ImportJobs => Set<ImportJob>(); public DbSet<ImportJob> ImportJobs => Set<ImportJob>();
public DbSet<Genre> Genres => Set<Genre>(); public DbSet<Genre> Genres => Set<Genre>();
public DbSet<NovelMember> NovelMembers => Set<NovelMember>(); public DbSet<NovelMember> NovelMembers => Set<NovelMember>();
public DbSet<ActivityEvent> ActivityEvents => Set<ActivityEvent>();
Task<int> INovelDbContext.SaveChangesAsync(CancellationToken cancellationToken) => base.SaveChangesAsync(cancellationToken); Task<int> INovelDbContext.SaveChangesAsync(CancellationToken cancellationToken) => base.SaveChangesAsync(cancellationToken);
@@ -62,6 +64,7 @@ public interface INovelDbContext
DbSet<Genre> Genres { get; } DbSet<Genre> Genres { get; }
DbSet<NovellyUser> Users { get; } DbSet<NovellyUser> Users { get; }
DbSet<NovelMember> NovelMembers { get; } DbSet<NovelMember> NovelMembers { get; }
DbSet<ActivityEvent> ActivityEvents { get; }
Task<int> SaveChangesAsync(CancellationToken cancellationToken = default); Task<int> SaveChangesAsync(CancellationToken cancellationToken = default);
} }
+65 -1
View File
@@ -23,7 +23,9 @@ public class ImportAgentService(
toolset.Initialize(sourceRoot, existingNovelId); toolset.Initialize(sourceRoot, existingNovelId);
var startingLedger = toolset.ReadLedgerOrNull(); var startingLedger = toolset.ReadLedgerOrNull();
var systemPrompt = BuildSystemPrompt(sourceRoot); var systemPrompt = ImportPaths.IsSingleFileSource(sourceRoot)
? BuildSingleFileSystemPrompt(sourceRoot)
: BuildSystemPrompt(sourceRoot);
var transcript = new List<AgentChatMessage> var transcript = new List<AgentChatMessage>
{ {
@@ -105,6 +107,9 @@ public class ImportAgentService(
private static string BuildSystemPrompt(string sourceRoot) => SystemPromptTemplate.Replace("{{SOURCE_ROOT}}", sourceRoot); private static string BuildSystemPrompt(string sourceRoot) => SystemPromptTemplate.Replace("{{SOURCE_ROOT}}", sourceRoot);
private static string BuildSingleFileSystemPrompt(string sourceRoot) =>
SingleFileSystemPromptTemplate.Replace("{{SOURCE_ROOT}}", sourceRoot);
private const string SystemPromptTemplate = """ private const string SystemPromptTemplate = """
You import a novel outline that already exists as markdown files on disk into this You import a novel outline that already exists as markdown files on disk into this
app's novel data. You are running unattended nobody will read your replies or app's novel data. You are running unattended nobody will read your replies or
@@ -199,4 +204,63 @@ public class ImportAgentService(
- If a tool call fails, stop that item and move on rather than retrying blindly - If a tool call fails, stop that item and move on rather than retrying blindly
the ledger stays at the last successful write either way. the ledger stays at the last successful write either way.
"""; """;
private const string SingleFileSystemPromptTemplate = """
You import a single outline file that already exists as markdown on disk into this
app's novel data. You are running unattended nobody will read your replies or
answer questions mid-run, so make the judgment calls yourself and record anything
genuinely ambiguous rather than stalling on it.
Your tools give you exactly two things: read-only access to the file under the
import source folder, and application tools that create the novel's chapters,
characters, beats and arcs. You cannot write or edit anything on disk except the
resume ledger, and you cannot read anything outside the source folder.
## Source file
The source root `{{SOURCE_ROOT}}` holds exactly one markdown file. Call
list_source_files to find its name, then read_source_file to read it. Decide what
kind of document it is before doing anything else:
- If it reads like a chapter outline (`# Chapter NN`, one or more summary
paragraphs, a beat table `| Beat | Character | What | Why |`) treat it as a single
chapter.
- If it reads like a character dossier (`# Name`, an italic tagline,
`## Appearance`, `## Background`, `## Motivation`) treat it as a single character.
`**Thread:**` (chapter files only) may name one character, several, or a character
plus a qualifier only auto-create an undossiered name from it when it names
exactly one clear proper name.
## The ledger
Before writing anything, call read_ledger. If it returns `{{}}`, this is a fresh
run. Call write_ledger with the full, updated ledger after every successful write.
## Passes
1. **Novel** skip if "novel" is in completedPasses or a novel id was already
supplied. Otherwise create one from whatever title/author information the file
gives, or a sensible placeholder title drawn from the file name if none is
present. Record novelId, mark "novel" done.
2. **The document** skip if already recorded. If it is a chapter: auto-create a
character stub (name only) for any single, unqualified name in the Thread or a
beat's Character column that isn't in the ledger yet, then create_chapter with
title, number (1 unless the file states otherwise), summary, and tags, then
create_beat for each table row with resolved character_ids. If it is a
character: create_character with occupation from the tagline and
appearance/backstory/want from Appearance/Background/Motivation; if it has a
`## Events` section, also update_character(importance: "Main") and add_arc_stage
for each bullet. Mark "characters", "chapters", and "arcs" all done once you've
handled the one document this run only ever has one item to place.
## Constraints
- Never invent plot content or character detail, and never guess which of several
candidate names an ambiguous reference means.
- Never write to disk except via write_ledger.
- Never call a create tool for something the ledger already records.
- If a tool call fails, stop and record what you have the ledger stays at the
last successful write either way.
""";
} }
@@ -241,7 +241,7 @@ public class ImportAgentToolset(
Occupation: JsonInput.String(input, "occupation"), Occupation: JsonInput.String(input, "occupation"),
Appearance: JsonInput.String(input, "appearance"), Appearance: JsonInput.String(input, "appearance"),
Backstory: JsonInput.String(input, "backstory"), Backstory: JsonInput.String(input, "backstory"),
Want: JsonInput.String(input, "want"), Motivation: JsonInput.String(input, "motivation"),
Notes: JsonInput.String(input, "notes")), ct); Notes: JsonInput.String(input, "notes")), ct);
return created is null return created is null
@@ -264,7 +264,7 @@ public class ImportAgentToolset(
Occupation: JsonInput.String(input, "occupation"), Occupation: JsonInput.String(input, "occupation"),
Appearance: JsonInput.String(input, "appearance"), Appearance: JsonInput.String(input, "appearance"),
Backstory: JsonInput.String(input, "backstory"), Backstory: JsonInput.String(input, "backstory"),
Want: JsonInput.String(input, "want"), Motivation: JsonInput.String(input, "motivation"),
Notes: JsonInput.String(input, "notes")), ct); Notes: JsonInput.String(input, "notes")), ct);
return updated is null return updated is null
@@ -274,10 +274,12 @@ public class ImportAgentToolset(
yield return new ImportAgentTool( yield return new ImportAgentTool(
"create_chapter", "create_chapter",
"Add a chapter. Its number is appended to the end of the manuscript unless you supply one.", "Add a chapter. Its number is appended to the end of the manuscript unless you supply one. "
+ "Use 'kind' for a foreword, prologue, afterword, or other unnumbered front/back matter.",
new JsonSchemaBuilder() new JsonSchemaBuilder()
.Str("title", "Chapter title.", required: true) .Str("title", "Chapter title.", required: true)
.Int("number", "Position in the manuscript, 1-based, matching the outline's chapter number.") .Int("number", "Position in the manuscript, 1-based, matching the outline's chapter number.")
.Enum("kind", "Front matter, a numbered body chapter, or back matter. Defaults to a body chapter.", System.Enum.GetNames<ChapterKind>())
.Str("summary", "The chapter's prose summary paragraph(s).") .Str("summary", "The chapter's prose summary paragraph(s).")
.Str("notes", "The chapter file's ## Notes section, if present.") .Str("notes", "The chapter file's ## Notes section, if present.")
.StringArray("tags", "The Part value and the raw Thread text, e.g. ['Part I', 'thread:Logen'].") .StringArray("tags", "The Part value and the raw Thread text, e.g. ['Part I', 'thread:Logen'].")
@@ -288,6 +290,7 @@ public class ImportAgentToolset(
var created = await chapters.CreateAsync(novelId, new CreateChapterRequest( var created = await chapters.CreateAsync(novelId, new CreateChapterRequest(
JsonInput.RequiredString(input, "title"), JsonInput.RequiredString(input, "title"),
JsonInput.Int(input, "number"), JsonInput.Int(input, "number"),
JsonInput.Enum<ChapterKind>(input, "kind") ?? ChapterKind.Body,
JsonInput.String(input, "summary"), JsonInput.String(input, "summary"),
Notes: JsonInput.String(input, "notes"), Notes: JsonInput.String(input, "notes"),
Tags: JsonInput.Strings(input, "tags")), ct); Tags: JsonInput.Strings(input, "tags")), ct);
@@ -379,6 +382,6 @@ public class ImportAgentToolset(
.Str("occupation", "The italic tagline under the heading.") .Str("occupation", "The italic tagline under the heading.")
.Str("appearance", "The ## Appearance section.") .Str("appearance", "The ## Appearance section.")
.Str("backstory", "The ## Background section.") .Str("backstory", "The ## Background section.")
.Str("want", "The ## Motivation section.") .Str("motivation", "The ## Motivation section.")
.Str("notes", "The ## Notes section, if present."); .Str("notes", "The ## Notes section, if present.");
} }
@@ -0,0 +1,81 @@
using Microsoft.Extensions.Options;
namespace Novelly.Api.Imports;
public class ImportBrowseService(IOptions<ImportOptions> options, ILogger<ImportBrowseService> logger)
{
private readonly ImportOptions _options = options.Value;
public string? RootPath => _options.RootPath;
public ImportBrowseResponse List(string? relativePath)
{
var root = RequireRoot();
logger.LogInformation("Browsing import root at {RelativePath}", relativePath ?? "");
var target = string.IsNullOrWhiteSpace(relativePath) ? root : ImportPaths.ResolveWithin(root, relativePath);
if (!Directory.Exists(target))
throw new ArgumentException($"'{relativePath}' does not exist or is not a directory.", nameof(relativePath));
var normalizedRelative = Path.GetRelativePath(root, target).Replace(Path.DirectorySeparatorChar, '/');
if (normalizedRelative == ".")
{
normalizedRelative = "";
}
var parent = normalizedRelative == "" ? null : Path.GetRelativePath(root, Path.GetFullPath(Path.Combine(target, ".."))).Replace(Path.DirectorySeparatorChar, '/');
if (parent == ".")
{
parent = "";
}
var entries = Directory.EnumerateFileSystemEntries(target)
.Select(BuildEntry)
.Where(e => e is not null)
.Select(e => e!)
.OrderByDescending(e => e.IsDirectory)
.ThenBy(e => e.Name, StringComparer.Ordinal)
.ToArray();
return new ImportBrowseResponse(normalizedRelative, parent, entries);
ImportBrowseEntry? BuildEntry(string path)
{
var name = Path.GetFileName(path);
if (name.StartsWith('.'))
{
return null;
}
var isDirectory = Directory.Exists(path);
if (!isDirectory && !name.EndsWith(".md", StringComparison.OrdinalIgnoreCase))
{
return null;
}
var entryRelative = Path.GetRelativePath(root, path).Replace(Path.DirectorySeparatorChar, '/');
var markdownCount = isDirectory ? ImportPaths.CountChapterFiles(path) : 0;
var looksImportable = isDirectory
? File.Exists(Path.Combine(path, "outline.md")) || markdownCount > 0
: true;
return new ImportBrowseEntry(name, entryRelative, path, isDirectory, markdownCount, looksImportable);
}
}
private string RequireRoot()
{
if (string.IsNullOrWhiteSpace(_options.RootPath))
throw new InvalidOperationException("No import root is configured (Imports:RootPath).");
var full = Path.GetFullPath(_options.RootPath);
Directory.CreateDirectory(full);
return full;
}
}
public record ImportBrowseEntry(string Name, string RelativePath, string SourceRoot, bool IsDirectory, int MarkdownFileCount, bool LooksImportable);
public record ImportBrowseResponse(string RelativePath, string? ParentRelativePath, IReadOnlyList<ImportBrowseEntry> Entries);
@@ -57,6 +57,8 @@ public class StartImportRequestValidator : IModelValidator<StartImportRequest>
} }
} }
public record ImportUploadResponse(string SourceRoot, string RelativePath, int MarkdownFileCount);
public static class ImportMapping public static class ImportMapping
{ {
public static ImportJobResponse ToResponse(this ImportJob job) => new( public static ImportJobResponse ToResponse(this ImportJob job) => new(
@@ -28,6 +28,24 @@ public static class ImportEndpoints
(await service.GetStatusAsync(id, ct))?.ToResponse().ToApiResult()) (await service.GetStatusAsync(id, ct))?.ToResponse().ToApiResult())
.WithSummary("Poll an import job's progress."); .WithSummary("Poll an import job's progress.");
imports.MapGet("/browse", (string? path, ImportBrowseService browse) =>
Results.Ok(browse.List(path)))
.WithSummary("List entries under the configured import root, for the source picker.");
imports.MapPost("/upload", (IFormFile file, ImportService service) =>
{
if (!file.FileName.EndsWith(".zip", StringComparison.OrdinalIgnoreCase))
throw new ArgumentException("Only .zip files can be uploaded.", nameof(file));
if (file.Length == 0)
throw new ArgumentException("The uploaded file is empty.", nameof(file));
using var stream = file.OpenReadStream();
return Results.Ok(service.UploadZip(stream, file.FileName));
})
.DisableAntiforgery()
.WithSummary("Upload a zip of an outline folder and stage it under the configured import root.");
return app; return app;
} }
} }
+8
View File
@@ -0,0 +1,8 @@
namespace Novelly.Api.Imports;
public class ImportOptions
{
public const string SectionName = "Imports";
public string? RootPath { get; set; }
}
+36 -3
View File
@@ -13,6 +13,7 @@ public record ImportLedger(
internal static class ImportPaths internal static class ImportPaths
{ {
private const string LedgerFileName = ".novelly-import.json"; private const string LedgerFileName = ".novelly-import.json";
public const string StagingFolderName = ".novelly-staging";
private static readonly JsonSerializerOptions LedgerOptions = new() private static readonly JsonSerializerOptions LedgerOptions = new()
{ {
@@ -20,7 +21,7 @@ internal static class ImportPaths
WriteIndented = true WriteIndented = true
}; };
public static string ResolveRoot(string sourceRoot) public static string ResolveRoot(string sourceRoot, string? importRoot = null)
{ {
if (string.IsNullOrWhiteSpace(sourceRoot)) if (string.IsNullOrWhiteSpace(sourceRoot))
throw new ArgumentException("'Source Root' must not be empty.", nameof(sourceRoot)); throw new ArgumentException("'Source Root' must not be empty.", nameof(sourceRoot));
@@ -38,25 +39,57 @@ internal static class ImportPaths
if (!Directory.Exists(full)) if (!Directory.Exists(full))
throw new ArgumentException($"'{full}' does not exist or is not a directory.", nameof(sourceRoot)); throw new ArgumentException($"'{full}' does not exist or is not a directory.", nameof(sourceRoot));
EnsureWithinImportRoot(importRoot, full, sourceRoot);
return full; return full;
} }
public static void EnsureWithinImportRoot(string? importRoot, string candidate, string originalInput)
{
if (importRoot is not null && !IsWithin(importRoot, candidate))
throw new ArgumentException($"'{originalInput}' is outside the configured import root.", nameof(originalInput));
}
public static bool IsSingleFileSource(string root)
{
if (Directory.EnumerateDirectories(root).Any())
{
return false;
}
return Directory.EnumerateFiles(root, "*.md", SearchOption.TopDirectoryOnly).Count() == 1;
}
public static string ResolveWithin(string root, string relativePath) public static string ResolveWithin(string root, string relativePath)
{ {
if (string.IsNullOrWhiteSpace(relativePath)) if (string.IsNullOrWhiteSpace(relativePath))
throw new ArgumentException("Path must not be empty."); throw new ArgumentException("Path must not be empty.");
var combined = Path.GetFullPath(Path.Combine(root, relativePath)); var combined = Path.GetFullPath(Path.Combine(root, relativePath));
var relativeToRoot = Path.GetRelativePath(root, combined);
if (relativeToRoot.StartsWith("..", StringComparison.Ordinal) || Path.IsPathRooted(relativeToRoot)) if (!IsWithin(root, combined))
throw new ArgumentException($"'{relativePath}' escapes the import source folder."); throw new ArgumentException($"'{relativePath}' escapes the import source folder.");
return combined; return combined;
} }
private static bool IsWithin(string root, string candidate)
{
var relativeToRoot = Path.GetRelativePath(root, candidate);
return relativeToRoot == "." || !relativeToRoot.StartsWith("..", StringComparison.Ordinal) && !Path.IsPathRooted(relativeToRoot);
}
public static string LedgerPath(string root) => Path.Combine(root, LedgerFileName); public static string LedgerPath(string root) => Path.Combine(root, LedgerFileName);
public static string StagingRoot(string importRoot) => Path.Combine(importRoot, StagingFolderName);
public static string SanitizeForFolderName(string value)
{
var sanitized = new string(value.Select(c => char.IsLetterOrDigit(c) || c is '-' or '_' ? c : '-').ToArray());
sanitized = sanitized.Trim('-', '_');
return string.IsNullOrEmpty(sanitized) ? "import" : sanitized[..Math.Min(sanitized.Length, 60)];
}
public static ImportLedger? ReadLedger(string root) public static ImportLedger? ReadLedger(string root)
{ {
var path = LedgerPath(root); var path = LedgerPath(root);
+61 -2
View File
@@ -1,5 +1,6 @@
using System.Threading.Channels; using System.Threading.Channels;
using Microsoft.EntityFrameworkCore; using Microsoft.EntityFrameworkCore;
using Microsoft.Extensions.Options;
using Novelly.Api.Common; using Novelly.Api.Common;
using Novelly.Api.Common.Validation; using Novelly.Api.Common.Validation;
using Novelly.Api.Data; using Novelly.Api.Data;
@@ -13,10 +14,34 @@ public class ImportService(
NovelService novels, NovelService novels,
Channel<Guid> queue, Channel<Guid> queue,
INovelUserContext userContext, INovelUserContext userContext,
IOptions<ImportOptions> importOptions,
ImportZipExtractor zipExtractor,
ILogger<ImportService> logger, ILogger<ImportService> logger,
IModelValidator<InspectImportRequest> inspectValidator, IModelValidator<InspectImportRequest> inspectValidator,
IModelValidator<StartImportRequest> startValidator) IModelValidator<StartImportRequest> startValidator)
{ {
private readonly string? _importRoot = importOptions.Value.RootPath is { } root ? Path.GetFullPath(root) : null;
public ImportUploadResponse UploadZip(Stream zipStream, string fileName)
{
if (_importRoot is null)
throw new InvalidOperationException("No import root is configured (Imports:RootPath).");
logger.LogInformation("Uploading import zip {FileName}", fileName);
Directory.CreateDirectory(_importRoot);
var stagingDir = Path.Combine(
ImportPaths.StagingRoot(_importRoot),
$"zip-{ImportPaths.SanitizeForFolderName(Path.GetFileNameWithoutExtension(fileName))}-{Guid.NewGuid():N}");
zipExtractor.Extract(zipStream, stagingDir);
var markdownCount = Directory.EnumerateFiles(stagingDir, "*.md", SearchOption.AllDirectories).Count();
var relativePath = Path.GetRelativePath(_importRoot, stagingDir).Replace(Path.DirectorySeparatorChar, '/');
return new ImportUploadResponse(stagingDir, relativePath, markdownCount);
}
public Task<ImportInspectionResponse> InspectAsync(InspectImportRequest request, CancellationToken ct = default) public Task<ImportInspectionResponse> InspectAsync(InspectImportRequest request, CancellationToken ct = default)
{ {
Guard.Null(request, nameof(request)); Guard.Null(request, nameof(request));
@@ -24,7 +49,7 @@ public class ImportService(
logger.LogInformation("Inspecting import source {SourceRoot}", request.SourceRoot); logger.LogInformation("Inspecting import source {SourceRoot}", request.SourceRoot);
var root = ImportPaths.ResolveRoot(request.SourceRoot); var root = ResolveSourceRoot(request.SourceRoot);
var ledger = ImportPaths.ReadLedger(root); var ledger = ImportPaths.ReadLedger(root);
var total = ImportPaths.CountChapterFiles(root); var total = ImportPaths.CountChapterFiles(root);
@@ -48,7 +73,7 @@ public class ImportService(
logger.LogInformation( logger.LogInformation(
"Starting import for {SourceRoot}, forceRestart {ForceRestart}", request.SourceRoot, request.ForceRestart); "Starting import for {SourceRoot}, forceRestart {ForceRestart}", request.SourceRoot, request.ForceRestart);
var root = ImportPaths.ResolveRoot(request.SourceRoot); var root = ResolveSourceRoot(request.SourceRoot);
if (request.ForceRestart) if (request.ForceRestart)
{ {
@@ -88,6 +113,40 @@ public class ImportService(
return job; return job;
} }
private string ResolveSourceRoot(string sourceRoot)
{
string full;
try
{
full = Path.GetFullPath(sourceRoot);
}
catch (Exception ex) when (ex is ArgumentException or NotSupportedException or PathTooLongException)
{
throw new ArgumentException($"'{sourceRoot}' is not a valid path.", nameof(sourceRoot), ex);
}
if (!File.Exists(full))
{
return ImportPaths.ResolveRoot(sourceRoot, _importRoot);
}
if (!full.EndsWith(".md", StringComparison.OrdinalIgnoreCase))
throw new ArgumentException($"'{sourceRoot}' is not a markdown file or a directory.", nameof(sourceRoot));
ImportPaths.EnsureWithinImportRoot(_importRoot, full, sourceRoot);
var stagingParent = _importRoot is not null
? ImportPaths.StagingRoot(_importRoot)
: Path.Combine(Path.GetTempPath(), "novelly-import-staging");
var stagingDir = Path.Combine(
stagingParent, $"file-{ImportPaths.SanitizeForFolderName(Path.GetFileNameWithoutExtension(full))}");
Directory.CreateDirectory(stagingDir);
File.Copy(full, Path.Combine(stagingDir, Path.GetFileName(full)), overwrite: true);
return stagingDir;
}
public async Task<ImportJob?> GetStatusAsync(Guid id, CancellationToken ct = default) public async Task<ImportJob?> GetStatusAsync(Guid id, CancellationToken ct = default)
{ {
Guard.Default(id, nameof(id)); Guard.Default(id, nameof(id));
@@ -0,0 +1,84 @@
using System.IO.Compression;
namespace Novelly.Api.Imports;
public class ImportZipExtractor(ILogger<ImportZipExtractor> logger)
{
private const int MaxEntryCount = 2000;
private const long MaxEntryUncompressedBytes = 10 * 1024 * 1024;
private const long MaxTotalUncompressedBytes = 100 * 1024 * 1024;
private static readonly string[] AllowedFileNames = [".novelly-import.json"];
public void Extract(Stream zipStream, string stagingDirectory)
{
Directory.CreateDirectory(stagingDirectory);
try
{
using var archive = new ZipArchive(zipStream, ZipArchiveMode.Read);
var entries = archive.Entries
.Where(e => !string.IsNullOrEmpty(e.Name))
.Where(e => !e.FullName.StartsWith("__MACOSX/", StringComparison.OrdinalIgnoreCase))
.Where(e => AllowedFileNames.Contains(e.Name) || !e.Name.StartsWith('.'))
.ToArray();
if (entries.Length == 0)
throw new ArgumentException("The zip file is empty.");
if (entries.Length > MaxEntryCount)
throw new ArgumentException($"The zip file has too many entries (max {MaxEntryCount}).");
var stripPrefix = FindCommonTopLevelDirectory(entries);
var totalBytes = 0L;
foreach (var entry in entries)
{
var relativePath = stripPrefix is null
? entry.FullName
: entry.FullName[(stripPrefix.Length + 1)..];
if (relativePath.Length == 0) continue;
if (!relativePath.EndsWith(".md", StringComparison.OrdinalIgnoreCase) && !AllowedFileNames.Contains(entry.Name))
throw new ArgumentException($"'{entry.FullName}' is not a markdown file. Only .md files (and .novelly-import.json) are allowed.");
if (entry.Length > MaxEntryUncompressedBytes)
throw new ArgumentException($"'{entry.FullName}' is too large (max {MaxEntryUncompressedBytes / (1024 * 1024)} MB per file).");
totalBytes += entry.Length;
if (totalBytes > MaxTotalUncompressedBytes)
throw new ArgumentException($"The zip file is too large uncompressed (max {MaxTotalUncompressedBytes / (1024 * 1024)} MB).");
var destination = ImportPaths.ResolveWithin(stagingDirectory, relativePath);
Directory.CreateDirectory(Path.GetDirectoryName(destination)!);
using var entryStream = entry.Open();
using var fileStream = File.Create(destination);
entryStream.CopyTo(fileStream);
}
logger.LogInformation("Extracted import zip with {EntryCount} entries into staging folder", entries.Length);
}
catch
{
if (Directory.Exists(stagingDirectory))
Directory.Delete(stagingDirectory, recursive: true);
throw;
}
}
private static string? FindCommonTopLevelDirectory(IReadOnlyCollection<ZipArchiveEntry> entries)
{
var topLevelSegments = entries
.Select(e => e.FullName.Split('/', '\\')[0])
.Distinct()
.ToArray();
return topLevelSegments.Length == 1 && entries.All(e => e.FullName.Contains('/') || e.FullName.Contains('\\'))
? topLevelSegments[0]
: null;
}
}
+5 -2
View File
@@ -1,11 +1,12 @@
using Microsoft.EntityFrameworkCore; using Microsoft.EntityFrameworkCore;
using Microsoft.EntityFrameworkCore.Metadata.Builders; using Microsoft.EntityFrameworkCore.Metadata.Builders;
using Novelly.Api.Chapters; using Novelly.Api.Chapters;
using Novelly.Api.Common;
using Novelly.Api.Novels; using Novelly.Api.Novels;
namespace Novelly.Api.Locations; namespace Novelly.Api.Locations;
public class Location public class Location : ISoftDeletable
{ {
public Guid Id { get; set; } = Guid.NewGuid(); public Guid Id { get; set; } = Guid.NewGuid();
@@ -17,6 +18,7 @@ public class Location
public List<Chapter> Chapters { get; set; } = []; public List<Chapter> Chapters { get; set; } = [];
public DateTimeOffset CreatedAt { get; set; } = DateTimeOffset.UtcNow; public DateTimeOffset CreatedAt { get; set; } = DateTimeOffset.UtcNow;
public DateTimeOffset? DeletedAt { get; set; }
} }
public class LocationEntityTypeConfiguration : IEntityTypeConfiguration<Location> public class LocationEntityTypeConfiguration : IEntityTypeConfiguration<Location>
@@ -25,7 +27,8 @@ public class LocationEntityTypeConfiguration : IEntityTypeConfiguration<Location
{ {
entity.Property(l => l.Name).IsRequired().HasMaxLength(120); entity.Property(l => l.Name).IsRequired().HasMaxLength(120);
entity.HasIndex(l => new { l.NovelId, l.Name }).IsUnique(); entity.HasIndex(l => new { l.NovelId, l.Name }).IsUnique().HasFilter("\"DeletedAt\" IS NULL");
entity.HasQueryFilter(l => l.DeletedAt == null);
entity.HasMany(l => l.Chapters).WithMany(c => c.Locations) entity.HasMany(l => l.Chapters).WithMany(c => c.Locations)
.UsingEntity(join => join.ToTable("ChapterLocations")); .UsingEntity(join => join.ToTable("ChapterLocations"));
@@ -1,3 +1,4 @@
using Novelly.Api.Chapters;
using Novelly.Api.Common.Validation; using Novelly.Api.Common.Validation;
namespace Novelly.Api.Locations; namespace Novelly.Api.Locations;
@@ -36,17 +37,20 @@ public class UpdateLocationRequestValidator : IModelValidator<UpdateLocationRequ
public record LocationReferencesResponse(LocationResponse Location, IReadOnlyList<LocatedChapterResponse> Chapters); public record LocationReferencesResponse(LocationResponse Location, IReadOnlyList<LocatedChapterResponse> Chapters);
public record LocatedChapterResponse(Guid Id, int Number, string Title, string? Summary); public record LocatedChapterResponse(Guid Id, int Number, ChapterKind Kind, int? DisplayNumber, string Title, string? Summary);
public static class LocationMapping public static class LocationMapping
{ {
public static LocationResponse ToResponse(this Location l) => new(l.Id, l.Name); public static LocationResponse ToResponse(this Location l) => new(l.Id, l.Name);
public static LocationReferencesResponse ToReferencesResponse(this Location location) => new( public static LocationReferencesResponse ToReferencesResponse(this Location location, IReadOnlyDictionary<Guid, int>? displayNumbers = null) => new(
location.ToResponse(), location.ToResponse(),
[.. location.Chapters [.. location.Chapters
.OrderBy(c => c.Number) .OrderBy(c => c.Number)
.Select(c => new LocatedChapterResponse(c.Id, c.Number, c.Title, c.Summary))]); .Select(c => new LocatedChapterResponse(
c.Id, c.Number, c.Kind,
displayNumbers is not null && displayNumbers.TryGetValue(c.Id, out var n) ? n : null,
c.Title, c.Summary))]);
public static string Normalise(string name) => name.Trim(); public static string Normalise(string name) => name.Trim();
} }
+13 -3
View File
@@ -1,3 +1,4 @@
using Novelly.Api.Chapters;
using Novelly.Api.Common; using Novelly.Api.Common;
using Novelly.Api.Common.Validation; using Novelly.Api.Common.Validation;
@@ -33,8 +34,17 @@ public static class LocationEndpoints
.AddEndpointFilter<RequestLoggingEndpointFilter>() .AddEndpointFilter<RequestLoggingEndpointFilter>()
.AddEndpointFilter<ValidationEndpointFilter>(); .AddEndpointFilter<ValidationEndpointFilter>();
locations.MapGet("/{id:guid}/references", async (Guid id, LocationService service, CancellationToken ct) => locations.MapGet("/{id:guid}/references", async (Guid id, LocationService service, ChapterDisplayNumberLookup chapterLabels, CancellationToken ct) =>
(await service.GetReferencesAsync(id, ct))?.ToReferencesResponse().ToApiResult()) {
var location = await service.GetReferencesAsync(id, ct);
if (location is null)
{
return Results.NotFound();
}
var displayNumbers = await chapterLabels.ForNovelAsync(location.NovelId, ct);
return location.ToReferencesResponse(displayNumbers).ToApiResult();
})
.WithSummary("Cross-reference: every chapter set at this location."); .WithSummary("Cross-reference: every chapter set at this location.");
locations.MapPatch("/{id:guid}", async ( locations.MapPatch("/{id:guid}", async (
@@ -44,7 +54,7 @@ public static class LocationEndpoints
locations.MapDelete("/{id:guid}", async (Guid id, LocationService service, CancellationToken ct) => locations.MapDelete("/{id:guid}", async (Guid id, LocationService service, CancellationToken ct) =>
await service.DeleteAsync(id, ct) ? Results.NoContent() : Results.NotFound()) await service.DeleteAsync(id, ct) ? Results.NoContent() : Results.NotFound())
.WithSummary("Delete a location. Whatever carried it is left alone."); .WithSummary("Move a location to the trash. Whatever carried it is left alone.");
return app; return app;
} }
+7 -2
View File
@@ -1,4 +1,5 @@
using Microsoft.EntityFrameworkCore; using Microsoft.EntityFrameworkCore;
using Novelly.Api.Activity;
using Novelly.Api.Common; using Novelly.Api.Common;
using Novelly.Api.Common.Validation; using Novelly.Api.Common.Validation;
using Novelly.Api.Data; using Novelly.Api.Data;
@@ -9,6 +10,7 @@ namespace Novelly.Api.Locations;
public class LocationService( public class LocationService(
INovelDbContext db, INovelDbContext db,
NovelAccessService access, NovelAccessService access,
ActivityLog activity,
ILogger<LocationService> logger, ILogger<LocationService> logger,
IModelValidator<CreateLocationRequest> createValidator, IModelValidator<CreateLocationRequest> createValidator,
IModelValidator<UpdateLocationRequest> updateValidator) IModelValidator<UpdateLocationRequest> updateValidator)
@@ -75,6 +77,7 @@ public class LocationService(
var location = new Location { NovelId = novelId, Name = name }; var location = new Location { NovelId = novelId, Name = name };
db.Locations.Add(location); db.Locations.Add(location);
activity.Record(novelId, ActivityEntityKind.Location, ActivityAction.Created, location.Id);
await db.SaveChangesAsync(ct); await db.SaveChangesAsync(ct);
return location; return location;
} }
@@ -110,6 +113,7 @@ public class LocationService(
location.Name = name; location.Name = name;
} }
activity.Record(location.NovelId, ActivityEntityKind.Location, ActivityAction.Updated, location.Id);
await db.SaveChangesAsync(ct); await db.SaveChangesAsync(ct);
return location; return location;
} }
@@ -118,7 +122,7 @@ public class LocationService(
{ {
Guard.Default(locationId, nameof(locationId)); Guard.Default(locationId, nameof(locationId));
logger.LogInformation("Deleting location {LocationId}", locationId); logger.LogInformation("Moving location {LocationId} to trash", locationId);
var location = await db.Locations.FirstOrDefaultAsync(l => l.Id == locationId, ct); var location = await db.Locations.FirstOrDefaultAsync(l => l.Id == locationId, ct);
if (location is null) if (location is null)
@@ -129,7 +133,8 @@ public class LocationService(
await access.RequireAsync(location.NovelId, NovelPermission.DeleteContent, ct); await access.RequireAsync(location.NovelId, NovelPermission.DeleteContent, ct);
db.Locations.Remove(location); location.DeletedAt = DateTimeOffset.UtcNow;
activity.Record(location.NovelId, ActivityEntityKind.Location, ActivityAction.Deleted, location.Id);
await db.SaveChangesAsync(ct); await db.SaveChangesAsync(ct);
return true; return true;
} }
+10
View File
@@ -0,0 +1,10 @@
namespace Novelly.Api.Mcp;
public static class McpEndpoints
{
public static IEndpointRouteBuilder MapNovelMcp(this IEndpointRouteBuilder app)
{
app.MapMcp("/mcp");
return app;
}
}
+109
View File
@@ -0,0 +1,109 @@
using System.Text.Json;
using System.Text.Json.Nodes;
using ModelContextProtocol.Protocol;
using Novelly.Api.Agent;
namespace Novelly.Api.Mcp;
public static class NovelMcpTools
{
private const string NovelIdProperty = "novelId";
public static IReadOnlyList<Tool> Describe(IReadOnlyList<AgentToolDefinition> definitions) =>
[.. definitions.Select(definition => new Tool
{
Name = definition.Name,
Description = definition.Description,
InputSchema = definition.RequiresNovelId ? WithNovelId(definition.InputSchema) : definition.InputSchema
})];
public static async Task<CallToolResult> CallAsync(
NovelAgentToolset toolset,
IReadOnlyList<AgentToolDefinition> definitions,
CallToolRequestParams parameters,
CancellationToken ct)
{
var definition = definitions.FirstOrDefault(d => d.Name == parameters.Name);
if (definition is null)
{
return new CallToolResult
{
IsError = true,
Content = [new TextContentBlock { Text = $"No such tool: '{parameters.Name}'." }]
};
}
var arguments = ToJsonElement(parameters.Arguments);
Guid novelId;
if (definition.RequiresNovelId)
{
try
{
novelId = JsonInput.RequiredGuid(arguments, NovelIdProperty);
}
catch (ArgumentException ex)
{
return new CallToolResult { IsError = true, Content = [new TextContentBlock { Text = ex.Message }] };
}
}
else
{
novelId = Guid.Empty;
}
var result = await toolset.ExecuteAsync(parameters.Name, novelId, arguments, ct);
return new CallToolResult
{
IsError = result.IsError,
Content = [new TextContentBlock { Text = result.Content }]
};
}
private static JsonElement ToJsonElement(IDictionary<string, JsonElement>? arguments)
{
if (arguments is null)
{
return JsonSerializer.Deserialize<JsonElement>("{}");
}
var obj = new JsonObject();
foreach (var (key, value) in arguments)
{
obj[key] = JsonNode.Parse(value.GetRawText());
}
return JsonSerializer.Deserialize<JsonElement>(obj.ToJsonString());
}
private static JsonElement WithNovelId(JsonElement schema)
{
var node = JsonNode.Parse(schema.GetRawText())!.AsObject();
var properties = new JsonObject
{
[NovelIdProperty] = new JsonObject
{
["type"] = "string",
["description"] = "The novel's id."
}
};
if (node["properties"] is JsonObject existingProperties)
{
foreach (var (key, value) in existingProperties.ToList())
{
existingProperties.Remove(key);
properties[key] = value;
}
}
node["properties"] = properties;
var required = node["required"] as JsonArray ?? [];
required.Insert(0, NovelIdProperty);
node["required"] = required;
return JsonSerializer.Deserialize<JsonElement>(node.ToJsonString());
}
}
+1
View File
@@ -14,6 +14,7 @@
</PackageReference> </PackageReference>
<PackageReference Include="Microsoft.EntityFrameworkCore.Sqlite" Version="10.0.10" /> <PackageReference Include="Microsoft.EntityFrameworkCore.Sqlite" Version="10.0.10" />
<PackageReference Include="Microsoft.OpenApi" Version="2.11.0" /> <PackageReference Include="Microsoft.OpenApi" Version="2.11.0" />
<PackageReference Include="ModelContextProtocol.AspNetCore" Version="2.1.0" />
<PackageReference Include="Serilog.AspNetCore" Version="10.0.0" /> <PackageReference Include="Serilog.AspNetCore" Version="10.0.0" />
<PackageReference Include="Serilog.Settings.Configuration" Version="10.0.1" /> <PackageReference Include="Serilog.Settings.Configuration" Version="10.0.1" />
<PackageReference Include="SQLitePCLRaw.bundle_e_sqlite3" Version="3.0.5" /> <PackageReference Include="SQLitePCLRaw.bundle_e_sqlite3" Version="3.0.5" />
+4
View File
@@ -1,4 +1,5 @@
using Microsoft.EntityFrameworkCore; using Microsoft.EntityFrameworkCore;
using Novelly.Api.Activity;
using Novelly.Api.Common; using Novelly.Api.Common;
using Novelly.Api.Common.Validation; using Novelly.Api.Common.Validation;
using Novelly.Api.Data; using Novelly.Api.Data;
@@ -10,6 +11,7 @@ public class NovelService(
INovelDbContext db, INovelDbContext db,
NovelAccessService access, NovelAccessService access,
INovelUserContext userContext, INovelUserContext userContext,
ActivityLog activity,
ILogger<NovelService> logger, ILogger<NovelService> logger,
IModelValidator<CreateNovelRequest> createValidator, IModelValidator<CreateNovelRequest> createValidator,
IModelValidator<UpdateNovelRequest> updateValidator) IModelValidator<UpdateNovelRequest> updateValidator)
@@ -69,6 +71,7 @@ public class NovelService(
}; };
db.Novels.Add(novel); db.Novels.Add(novel);
activity.Record(novel.Id, ActivityEntityKind.Novel, ActivityAction.Created, novel.Id);
await db.SaveChangesAsync(ct); await db.SaveChangesAsync(ct);
return novel; return novel;
} }
@@ -96,6 +99,7 @@ public class NovelService(
novel.Phase = request.Phase ?? novel.Phase; novel.Phase = request.Phase ?? novel.Phase;
novel.UpdatedAt = DateTimeOffset.UtcNow; novel.UpdatedAt = DateTimeOffset.UtcNow;
activity.Record(novel.Id, ActivityEntityKind.Novel, ActivityAction.Updated, novel.Id);
await db.SaveChangesAsync(ct); await db.SaveChangesAsync(ct);
return novel; return novel;
} }
+33 -1
View File
@@ -2,6 +2,7 @@ using System.Diagnostics.CodeAnalysis;
using System.Text.Json.Serialization; using System.Text.Json.Serialization;
using Microsoft.AspNetCore.Diagnostics; using Microsoft.AspNetCore.Diagnostics;
using Microsoft.EntityFrameworkCore; using Microsoft.EntityFrameworkCore;
using Novelly.Api.Activity;
using Novelly.Api.Agent; using Novelly.Api.Agent;
using Novelly.Api.Beats; using Novelly.Api.Beats;
using Novelly.Api.Chapters; using Novelly.Api.Chapters;
@@ -11,9 +12,11 @@ using Novelly.Api.Data;
using Novelly.Api.Genres; using Novelly.Api.Genres;
using Novelly.Api.Imports; using Novelly.Api.Imports;
using Novelly.Api.Locations; using Novelly.Api.Locations;
using Novelly.Api.Mcp;
using Novelly.Api.Novels; using Novelly.Api.Novels;
using Novelly.Api.Questions; using Novelly.Api.Questions;
using Novelly.Api.Tags; using Novelly.Api.Tags;
using Novelly.Api.Trash;
using Novelly.Api.Users; using Novelly.Api.Users;
using Serilog; using Serilog;
@@ -41,13 +44,38 @@ builder.Services.AddCors(options => options.AddDefaultPolicy(policy => policy
.AllowAnyMethod() .AllowAnyMethod()
.AllowCredentials())); .AllowCredentials()));
var migrateOnly = args.Contains("--migrate-only");
var app = builder.Build(); var app = builder.Build();
using (var scope = app.Services.CreateScope()) using (var scope = app.Services.CreateScope())
{ {
var db = scope.ServiceProvider.GetRequiredService<NovelDbContext>(); var db = scope.ServiceProvider.GetRequiredService<NovelDbContext>();
try
{
await db.Database.MigrateAsync(); await db.Database.MigrateAsync();
}
catch (Exception ex)
{
app.Logger.LogCritical(ex, "Database migration failed on startup");
Environment.Exit(1);
}
if (migrateOnly)
{
app.Logger.LogInformation("Migration complete, exiting ({MigrateOnlyFlag})", "--migrate-only");
Environment.Exit(0);
}
await ServiceUser.EnsureSeededAsync(db, builder.Configuration[ServiceApiKeyAuthenticationHandler.ConfigurationKey], app.Logger); await ServiceUser.EnsureSeededAsync(db, builder.Configuration[ServiceApiKeyAuthenticationHandler.ConfigurationKey], app.Logger);
await ActivityBackfill.RunAsync(db, app.Logger);
var importRoot = builder.Configuration.GetSection(ImportOptions.SectionName)[nameof(ImportOptions.RootPath)];
if (!string.IsNullOrWhiteSpace(importRoot))
{
Directory.CreateDirectory(importRoot);
}
} }
app.UseSerilogRequestLogging(); app.UseSerilogRequestLogging();
@@ -85,8 +113,10 @@ if (app.Environment.IsDevelopment())
} }
app.MapDefaultEndpoints(); app.MapDefaultEndpoints();
app.MapNovelMcp();
app.MapGet("/api/health", () => Results.Ok(new { status = "ok" })).WithTags("Health").AllowAnonymous(); app.MapGet("/api/health", () => Results.Ok(new { status = "ok" })).WithTags("Health").AllowAnonymous();
app.MapUiSettingsEndpoints();
app.MapUserEndpoints(); app.MapUserEndpoints();
app.MapNovelMemberEndpoints(); app.MapNovelMemberEndpoints();
@@ -100,7 +130,9 @@ app.MapNovelEndpoints()
.MapGenreEndpoints() .MapGenreEndpoints()
.MapOpenQuestionEndpoints() .MapOpenQuestionEndpoints()
.MapAgentEndpoints() .MapAgentEndpoints()
.MapImportEndpoints(); .MapImportEndpoints()
.MapActivityEndpoints()
.MapTrashEndpoints();
app.Run(); app.Run();
@@ -1,3 +1,4 @@
using Novelly.Api.Chapters;
using Novelly.Api.Common.Validation; using Novelly.Api.Common.Validation;
namespace Novelly.Api.Questions; namespace Novelly.Api.Questions;
@@ -10,6 +11,7 @@ public record OpenQuestionResponse(
Guid? ChapterId, Guid? ChapterId,
int? ChapterNumber, int? ChapterNumber,
string? ChapterTitle, string? ChapterTitle,
string? ChapterLabel,
Guid? CharacterId, Guid? CharacterId,
string? CharacterName, string? CharacterName,
string? Resolution, string? Resolution,
@@ -74,19 +76,28 @@ public class ResolveOpenQuestionRequestValidator : IModelValidator<ResolveOpenQu
public static class OpenQuestionMapping public static class OpenQuestionMapping
{ {
public static OpenQuestionResponse ToResponse(this OpenQuestion q) => new( public static OpenQuestionResponse ToResponse(this OpenQuestion q, IReadOnlyDictionary<Guid, int>? displayNumbers = null)
{
var chapter = q.Chapter is { DeletedAt: null } ? q.Chapter : null;
var character = q.Character is { DeletedAt: null } ? q.Character : null;
return new(
q.Id, q.Id,
q.NovelId, q.NovelId,
q.Question, q.Question,
q.Detail, q.Detail,
q.ChapterId, q.ChapterId,
q.Chapter?.Number, chapter?.Number,
q.Chapter?.Title, chapter?.Title,
chapter is not null
? ChapterNumbering.Label(chapter.Kind, displayNumbers is not null && displayNumbers.TryGetValue(chapter.Id, out var n) ? n : null, chapter.Title)
: null,
q.CharacterId, q.CharacterId,
q.Character?.Name, character?.Name,
q.Resolution, q.Resolution,
q.IsResolved, q.IsResolved,
q.ResolvedAt, q.ResolvedAt,
q.CreatedAt, q.CreatedAt,
q.UpdatedAt); q.UpdatedAt);
} }
}
@@ -1,3 +1,4 @@
using Novelly.Api.Chapters;
using Novelly.Api.Common; using Novelly.Api.Common;
using Novelly.Api.Common.Validation; using Novelly.Api.Common.Validation;
@@ -14,15 +15,20 @@ public static class OpenQuestionEndpoints
novelScoped.MapGet("/", async ( novelScoped.MapGet("/", async (
Guid novelId, Guid novelId,
OpenQuestionService service, OpenQuestionService service,
ChapterDisplayNumberLookup chapterLabels,
CancellationToken ct, CancellationToken ct,
Guid? chapterId = null, Guid? chapterId = null,
Guid? characterId = null, Guid? characterId = null,
bool includeResolved = false) => bool includeResolved = false) =>
Results.Ok((await service.ListAsync(novelId, chapterId, characterId, includeResolved, ct)).Select(q => q.ToResponse()))) {
var list = await service.ListAsync(novelId, chapterId, characterId, includeResolved, ct);
var displayNumbers = await chapterLabels.ForNovelAsync(novelId, ct);
return Results.Ok(list.Select(q => q.ToResponse(displayNumbers)));
})
.WithSummary("List a novel's open questions, optionally narrowed to one chapter or character."); .WithSummary("List a novel's open questions, optionally narrowed to one chapter or character.");
novelScoped.MapPost("/", async ( novelScoped.MapPost("/", async (
Guid novelId, CreateOpenQuestionRequest request, OpenQuestionService service, CancellationToken ct) => Guid novelId, CreateOpenQuestionRequest request, OpenQuestionService service, ChapterDisplayNumberLookup chapterLabels, CancellationToken ct) =>
{ {
var question = await service.CreateAsync(novelId, request, ct); var question = await service.CreateAsync(novelId, request, ct);
if (question is null) if (question is null)
@@ -30,7 +36,8 @@ public static class OpenQuestionEndpoints
return Results.NotFound(); return Results.NotFound();
} }
var created = question.ToResponse(); var displayNumbers = await chapterLabels.ForNovelAsync(novelId, ct);
var created = question.ToResponse(displayNumbers);
return Results.Created($"/api/questions/{created.Id}", created); return Results.Created($"/api/questions/{created.Id}", created);
}) })
.WithSummary("Raise an open question, optionally against a chapter outline and/or a character."); .WithSummary("Raise an open question, optionally against a chapter outline and/or a character.");
@@ -39,22 +46,22 @@ public static class OpenQuestionEndpoints
.AddEndpointFilter<RequestLoggingEndpointFilter>() .AddEndpointFilter<RequestLoggingEndpointFilter>()
.AddEndpointFilter<ValidationEndpointFilter>(); .AddEndpointFilter<ValidationEndpointFilter>();
questions.MapGet("/{id:guid}", async (Guid id, OpenQuestionService service, CancellationToken ct) => questions.MapGet("/{id:guid}", async (Guid id, OpenQuestionService service, ChapterDisplayNumberLookup chapterLabels, CancellationToken ct) =>
(await service.GetAsync(id, ct))?.ToResponse().ToApiResult()) await WithLabel(await service.GetAsync(id, ct), chapterLabels, ct))
.WithSummary("Read one question."); .WithSummary("Read one question.");
questions.MapPatch("/{id:guid}", async ( questions.MapPatch("/{id:guid}", async (
Guid id, UpdateOpenQuestionRequest request, OpenQuestionService service, CancellationToken ct) => Guid id, UpdateOpenQuestionRequest request, OpenQuestionService service, ChapterDisplayNumberLookup chapterLabels, CancellationToken ct) =>
(await service.UpdateAsync(id, request, ct))?.ToResponse().ToApiResult()) await WithLabel(await service.UpdateAsync(id, request, ct), chapterLabels, ct))
.WithSummary("Update a question or change what it is attached to."); .WithSummary("Update a question or change what it is attached to.");
questions.MapPost("/{id:guid}/resolve", async ( questions.MapPost("/{id:guid}/resolve", async (
Guid id, ResolveOpenQuestionRequest request, OpenQuestionService service, CancellationToken ct) => Guid id, ResolveOpenQuestionRequest request, OpenQuestionService service, ChapterDisplayNumberLookup chapterLabels, CancellationToken ct) =>
(await service.ResolveAsync(id, request, ct))?.ToResponse().ToApiResult()) await WithLabel(await service.ResolveAsync(id, request, ct), chapterLabels, ct))
.WithSummary("Settle a question, optionally appending the resolution to the notes it hangs off."); .WithSummary("Settle a question, optionally appending the resolution to the notes it hangs off.");
questions.MapPost("/{id:guid}/reopen", async (Guid id, OpenQuestionService service, CancellationToken ct) => questions.MapPost("/{id:guid}/reopen", async (Guid id, OpenQuestionService service, ChapterDisplayNumberLookup chapterLabels, CancellationToken ct) =>
(await service.ReopenAsync(id, ct))?.ToResponse().ToApiResult()) await WithLabel(await service.ReopenAsync(id, ct), chapterLabels, ct))
.WithSummary("Put a resolved question back on the list."); .WithSummary("Put a resolved question back on the list.");
questions.MapDelete("/{id:guid}", async (Guid id, OpenQuestionService service, CancellationToken ct) => questions.MapDelete("/{id:guid}", async (Guid id, OpenQuestionService service, CancellationToken ct) =>
@@ -63,4 +70,15 @@ public static class OpenQuestionEndpoints
return app; return app;
} }
private static async Task<IResult> WithLabel(OpenQuestion? question, ChapterDisplayNumberLookup chapterLabels, CancellationToken ct)
{
if (question is null)
{
return Results.NotFound();
}
var displayNumbers = await chapterLabels.ForNovelAsync(question.NovelId, ct);
return Results.Ok(question.ToResponse(displayNumbers));
}
} }
@@ -1,4 +1,5 @@
using Microsoft.EntityFrameworkCore; using Microsoft.EntityFrameworkCore;
using Novelly.Api.Activity;
using Novelly.Api.Chapters; using Novelly.Api.Chapters;
using Novelly.Api.Characters; using Novelly.Api.Characters;
using Novelly.Api.Common; using Novelly.Api.Common;
@@ -11,6 +12,7 @@ namespace Novelly.Api.Questions;
public class OpenQuestionService( public class OpenQuestionService(
INovelDbContext db, INovelDbContext db,
NovelAccessService access, NovelAccessService access,
ActivityLog activity,
ILogger<OpenQuestionService> logger, ILogger<OpenQuestionService> logger,
IModelValidator<CreateOpenQuestionRequest> createValidator, IModelValidator<CreateOpenQuestionRequest> createValidator,
IModelValidator<UpdateOpenQuestionRequest> updateValidator, IModelValidator<UpdateOpenQuestionRequest> updateValidator,
@@ -102,6 +104,7 @@ public class OpenQuestionService(
}; };
db.OpenQuestions.Add(question); db.OpenQuestions.Add(question);
activity.Record(novelId, ActivityEntityKind.Question, ActivityAction.Created, question.Id);
await db.SaveChangesAsync(ct); await db.SaveChangesAsync(ct);
return (await FindAsync(question.Id, ct))!; return (await FindAsync(question.Id, ct))!;
@@ -131,6 +134,7 @@ public class OpenQuestionService(
question.CharacterId = request.ClearCharacter ? null : request.CharacterId ?? question.CharacterId; question.CharacterId = request.ClearCharacter ? null : request.CharacterId ?? question.CharacterId;
question.UpdatedAt = DateTimeOffset.UtcNow; question.UpdatedAt = DateTimeOffset.UtcNow;
activity.Record(question.NovelId, ActivityEntityKind.Question, ActivityAction.Updated, question.Id);
await db.SaveChangesAsync(ct); await db.SaveChangesAsync(ct);
return (await FindAsync(id, ct))!; return (await FindAsync(id, ct))!;
} }
@@ -185,6 +189,7 @@ public class OpenQuestionService(
} }
} }
activity.Record(question.NovelId, ActivityEntityKind.Question, ActivityAction.Updated, question.Id);
await db.SaveChangesAsync(ct); await db.SaveChangesAsync(ct);
return (await FindAsync(id, ct))!; return (await FindAsync(id, ct))!;
} }
@@ -207,6 +212,7 @@ public class OpenQuestionService(
question.ResolvedAt = null; question.ResolvedAt = null;
question.UpdatedAt = DateTimeOffset.UtcNow; question.UpdatedAt = DateTimeOffset.UtcNow;
activity.Record(question.NovelId, ActivityEntityKind.Question, ActivityAction.Updated, question.Id);
await db.SaveChangesAsync(ct); await db.SaveChangesAsync(ct);
return (await FindAsync(id, ct))!; return (await FindAsync(id, ct))!;
} }
@@ -226,6 +232,7 @@ public class OpenQuestionService(
await access.RequireAsync(question.NovelId, NovelPermission.DeleteContent, ct); await access.RequireAsync(question.NovelId, NovelPermission.DeleteContent, ct);
db.OpenQuestions.Remove(question); db.OpenQuestions.Remove(question);
activity.Record(question.NovelId, ActivityEntityKind.Question, ActivityAction.Deleted, question.Id);
await db.SaveChangesAsync(ct); await db.SaveChangesAsync(ct);
return true; return true;
} }
+11 -3
View File
@@ -1,3 +1,4 @@
using Novelly.Api.Chapters;
using Novelly.Api.Common.Validation; using Novelly.Api.Common.Validation;
namespace Novelly.Api.Tags; namespace Novelly.Api.Tags;
@@ -53,13 +54,14 @@ public record TagReferencesResponse(
public record TaggedCharacterResponse(Guid Id, string Name, string Role); public record TaggedCharacterResponse(Guid Id, string Name, string Role);
public record TaggedChapterResponse(Guid Id, int Number, string Title, string? Summary); public record TaggedChapterResponse(Guid Id, int Number, ChapterKind Kind, int? DisplayNumber, string Title, string? Summary);
public record TaggedBeatResponse( public record TaggedBeatResponse(
Guid Id, Guid Id,
Guid ChapterId, Guid ChapterId,
int ChapterNumber, int ChapterNumber,
string ChapterTitle, string ChapterTitle,
string ChapterLabel,
int SortOrder, int SortOrder,
string Title, string Title,
string? CharacterName, string? CharacterName,
@@ -69,14 +71,17 @@ public static class TagMapping
{ {
public static TagResponse ToResponse(this Tag t) => new(t.Id, t.Name, t.Color); public static TagResponse ToResponse(this Tag t) => new(t.Id, t.Name, t.Color);
public static TagReferencesResponse ToReferencesResponse(this Tag tag) => new( public static TagReferencesResponse ToReferencesResponse(this Tag tag, IReadOnlyDictionary<Guid, int>? displayNumbers = null) => new(
tag.ToResponse(), tag.ToResponse(),
[.. tag.Characters [.. tag.Characters
.OrderBy(c => c.Name) .OrderBy(c => c.Name)
.Select(c => new TaggedCharacterResponse(c.Id, c.Name, c.Role.ToString()))], .Select(c => new TaggedCharacterResponse(c.Id, c.Name, c.Role.ToString()))],
[.. tag.Chapters [.. tag.Chapters
.OrderBy(c => c.Number) .OrderBy(c => c.Number)
.Select(c => new TaggedChapterResponse(c.Id, c.Number, c.Title, c.Summary))], .Select(c => new TaggedChapterResponse(
c.Id, c.Number, c.Kind,
displayNumbers is not null && displayNumbers.TryGetValue(c.Id, out var n) ? n : null,
c.Title, c.Summary))],
[.. tag.Beats [.. tag.Beats
.OrderBy(b => b.Chapter?.Number ?? 0) .OrderBy(b => b.Chapter?.Number ?? 0)
.ThenBy(b => b.SortOrder) .ThenBy(b => b.SortOrder)
@@ -85,6 +90,9 @@ public static class TagMapping
b.ChapterId, b.ChapterId,
b.Chapter?.Number ?? 0, b.Chapter?.Number ?? 0,
b.Chapter?.Title ?? "(unknown chapter)", b.Chapter?.Title ?? "(unknown chapter)",
b.Chapter is { } chapter
? ChapterNumbering.Label(chapter.Kind, displayNumbers is not null && displayNumbers.TryGetValue(chapter.Id, out var bn) ? bn : null, chapter.Title)
: "(unknown chapter)",
b.SortOrder, b.SortOrder,
b.Title, b.Title,
b.Characters.Count > 0 ? string.Join(", ", b.Characters.OrderBy(c => c.Name).Select(c => c.Name)) : null, b.Characters.Count > 0 ? string.Join(", ", b.Characters.OrderBy(c => c.Name).Select(c => c.Name)) : null,
+12 -2
View File
@@ -1,3 +1,4 @@
using Novelly.Api.Chapters;
using Novelly.Api.Common; using Novelly.Api.Common;
using Novelly.Api.Common.Validation; using Novelly.Api.Common.Validation;
@@ -33,8 +34,17 @@ public static class TagEndpoints
.AddEndpointFilter<RequestLoggingEndpointFilter>() .AddEndpointFilter<RequestLoggingEndpointFilter>()
.AddEndpointFilter<ValidationEndpointFilter>(); .AddEndpointFilter<ValidationEndpointFilter>();
tags.MapGet("/{id:guid}/references", async (Guid id, TagService service, CancellationToken ct) => tags.MapGet("/{id:guid}/references", async (Guid id, TagService service, ChapterDisplayNumberLookup chapterLabels, CancellationToken ct) =>
(await service.GetReferencesAsync(id, ct))?.ToReferencesResponse().ToApiResult()) {
var tag = await service.GetReferencesAsync(id, ct);
if (tag is null)
{
return Results.NotFound();
}
var displayNumbers = await chapterLabels.ForNovelAsync(tag.NovelId, ct);
return tag.ToReferencesResponse(displayNumbers).ToApiResult();
})
.WithSummary("Cross-reference: every character, chapter and beat carrying this tag."); .WithSummary("Cross-reference: every character, chapter and beat carrying this tag.");
tags.MapPatch("/{id:guid}", async ( tags.MapPatch("/{id:guid}", async (
+5
View File
@@ -1,4 +1,5 @@
using Microsoft.EntityFrameworkCore; using Microsoft.EntityFrameworkCore;
using Novelly.Api.Activity;
using Novelly.Api.Common; using Novelly.Api.Common;
using Novelly.Api.Common.Validation; using Novelly.Api.Common.Validation;
using Novelly.Api.Data; using Novelly.Api.Data;
@@ -9,6 +10,7 @@ namespace Novelly.Api.Tags;
public class TagService( public class TagService(
INovelDbContext db, INovelDbContext db,
NovelAccessService access, NovelAccessService access,
ActivityLog activity,
ILogger<TagService> logger, ILogger<TagService> logger,
IModelValidator<CreateTagRequest> createValidator, IModelValidator<CreateTagRequest> createValidator,
IModelValidator<UpdateTagRequest> updateValidator) IModelValidator<UpdateTagRequest> updateValidator)
@@ -80,6 +82,7 @@ public class TagService(
var tag = new Tag { NovelId = novelId, Name = name, Color = request.Color }; var tag = new Tag { NovelId = novelId, Name = name, Color = request.Color };
db.Tags.Add(tag); db.Tags.Add(tag);
activity.Record(novelId, ActivityEntityKind.Tag, ActivityAction.Created, tag.Id);
await db.SaveChangesAsync(ct); await db.SaveChangesAsync(ct);
return tag; return tag;
} }
@@ -116,6 +119,7 @@ public class TagService(
} }
tag.Color = Patch.Apply(tag.Color, request.Color); tag.Color = Patch.Apply(tag.Color, request.Color);
activity.Record(tag.NovelId, ActivityEntityKind.Tag, ActivityAction.Updated, tag.Id);
await db.SaveChangesAsync(ct); await db.SaveChangesAsync(ct);
return tag; return tag;
} }
@@ -136,6 +140,7 @@ public class TagService(
await access.RequireAsync(tag.NovelId, NovelPermission.DeleteContent, ct); await access.RequireAsync(tag.NovelId, NovelPermission.DeleteContent, ct);
db.Tags.Remove(tag); db.Tags.Remove(tag);
activity.Record(tag.NovelId, ActivityEntityKind.Tag, ActivityAction.Deleted, tag.Id);
await db.SaveChangesAsync(ct); await db.SaveChangesAsync(ct);
return true; return true;
} }
+9
View File
@@ -0,0 +1,9 @@
namespace Novelly.Api.Trash;
public record TrashedItemResponse(
Guid Id,
TrashEntityKind Kind,
string Label,
string? Detail,
DateTimeOffset DeletedAt,
DateTimeOffset PurgeAfter);
+38
View File
@@ -0,0 +1,38 @@
using Novelly.Api.Common;
using Novelly.Api.Common.Validation;
namespace Novelly.Api.Trash;
public static class TrashEndpoints
{
public static IEndpointRouteBuilder MapTrashEndpoints(this IEndpointRouteBuilder app)
{
var novelScoped = app.MapGroup("/api/novels/{novelId:guid}/trash").WithTags("Trash")
.AddEndpointFilter<RequestLoggingEndpointFilter>()
.AddEndpointFilter<ValidationEndpointFilter>();
novelScoped.MapGet("/", async (Guid novelId, TrashService service, CancellationToken ct) =>
Results.Ok(await service.ListAsync(novelId, ct)))
.WithSummary("List everything in a novel's trash.");
novelScoped.MapDelete("/", async (Guid novelId, TrashService service, CancellationToken ct) =>
Results.Ok(new { purged = await service.EmptyAsync(novelId, ct) }))
.WithSummary("Empty a novel's trash, permanently deleting everything in it.");
var trash = app.MapGroup("/api/trash").WithTags("Trash")
.AddEndpointFilter<RequestLoggingEndpointFilter>()
.AddEndpointFilter<ValidationEndpointFilter>();
trash.MapPost("/{kind}/{id:guid}/restore", async (
TrashEntityKind kind, Guid id, TrashService service, CancellationToken ct) =>
await service.RestoreAsync(kind, id, ct) ? Results.NoContent() : Results.NotFound())
.WithSummary("Restore a trashed item.");
trash.MapDelete("/{kind}/{id:guid}", async (
TrashEntityKind kind, Guid id, TrashService service, CancellationToken ct) =>
await service.PurgeAsync(kind, id, ct) ? Results.NoContent() : Results.NotFound())
.WithSummary("Permanently delete a trashed item.");
return app;
}
}
+8
View File
@@ -0,0 +1,8 @@
namespace Novelly.Api.Trash;
public enum TrashEntityKind
{
Character,
Chapter,
Location
}
+10
View File
@@ -0,0 +1,10 @@
namespace Novelly.Api.Trash;
public class TrashOptions
{
public const string SectionName = "Trash";
public bool Enabled { get; set; } = true;
public int RetentionDays { get; set; } = 30;
public TimeOnly PurgeAtLocalTime { get; set; } = new(2, 0);
}
+57
View File
@@ -0,0 +1,57 @@
using Microsoft.EntityFrameworkCore;
using Novelly.Api.Data;
namespace Novelly.Api.Trash;
internal static class TrashPurge
{
public static async Task<bool> RemoveAsync(INovelDbContext db, TrashEntityKind kind, Guid id, CancellationToken ct) => kind switch
{
TrashEntityKind.Character => await RemoveCharacterAsync(db, id, ct),
TrashEntityKind.Chapter => await RemoveChapterAsync(db, id, ct),
TrashEntityKind.Location => await RemoveLocationAsync(db, id, ct),
_ => throw new ArgumentOutOfRangeException(nameof(kind), kind, null)
};
private static async Task<bool> RemoveCharacterAsync(INovelDbContext db, Guid id, CancellationToken ct)
{
var character = await db.Characters.IgnoreQueryFilters().FirstOrDefaultAsync(c => c.Id == id, ct);
if (character is null)
{
return false;
}
var inboundRelationships = await db.CharacterRelationships
.IgnoreQueryFilters()
.Where(r => r.RelatedCharacterId == id)
.ToListAsync(ct);
db.CharacterRelationships.RemoveRange(inboundRelationships);
db.Characters.Remove(character);
return true;
}
private static async Task<bool> RemoveChapterAsync(INovelDbContext db, Guid id, CancellationToken ct)
{
var chapter = await db.Chapters.IgnoreQueryFilters().FirstOrDefaultAsync(c => c.Id == id, ct);
if (chapter is null)
{
return false;
}
db.Chapters.Remove(chapter);
return true;
}
private static async Task<bool> RemoveLocationAsync(INovelDbContext db, Guid id, CancellationToken ct)
{
var location = await db.Locations.IgnoreQueryFilters().FirstOrDefaultAsync(l => l.Id == id, ct);
if (location is null)
{
return false;
}
db.Locations.Remove(location);
return true;
}
}
+84
View File
@@ -0,0 +1,84 @@
using Microsoft.EntityFrameworkCore;
using Microsoft.Extensions.Options;
using Novelly.Api.Data;
namespace Novelly.Api.Trash;
public class TrashPurgeRunner(
IServiceScopeFactory scopeFactory,
IOptions<TrashOptions> options,
TimeProvider clock,
ILogger<TrashPurgeRunner> logger) : BackgroundService
{
protected override async Task ExecuteAsync(CancellationToken stoppingToken)
{
if (!options.Value.Enabled)
{
logger.LogInformation("Trash purge is disabled");
return;
}
await RunPurgePassAsync(stoppingToken);
while (!stoppingToken.IsCancellationRequested)
{
var now = clock.GetLocalNow();
var delay = TrashPurgeSchedule.NextRunAfter(now, options.Value.PurgeAtLocalTime) - now;
try
{
await Task.Delay(delay, clock, stoppingToken);
}
catch (OperationCanceledException)
{
break;
}
await RunPurgePassAsync(stoppingToken);
}
}
private async Task RunPurgePassAsync(CancellationToken ct)
{
try
{
using var scope = scopeFactory.CreateScope();
var db = scope.ServiceProvider.GetRequiredService<INovelDbContext>();
var cutoff = clock.GetUtcNow().AddDays(-options.Value.RetentionDays);
var (characterCount, chapterCount, locationCount) = await SweepAsync(db, cutoff, ct);
logger.LogInformation(
"Trash purge removed {CharacterCount} characters, {ChapterCount} chapters, {LocationCount} locations",
characterCount, chapterCount, locationCount);
}
catch (Exception ex) when (ex is not OperationCanceledException)
{
logger.LogError(ex, "Trash purge pass failed");
}
}
public static async Task<(int Characters, int Chapters, int Locations)> SweepAsync(
INovelDbContext db, DateTimeOffset cutoff, CancellationToken ct)
{
var characterIds = await db.Characters.IgnoreQueryFilters()
.Where(c => c.DeletedAt != null && c.DeletedAt < cutoff).Select(c => c.Id).ToListAsync(ct);
var chapterIds = await db.Chapters.IgnoreQueryFilters()
.Where(c => c.DeletedAt != null && c.DeletedAt < cutoff).Select(c => c.Id).ToListAsync(ct);
var locationIds = await db.Locations.IgnoreQueryFilters()
.Where(l => l.DeletedAt != null && l.DeletedAt < cutoff).Select(l => l.Id).ToListAsync(ct);
foreach (var id in characterIds)
await TrashPurge.RemoveAsync(db, TrashEntityKind.Character, id, ct);
foreach (var id in chapterIds)
await TrashPurge.RemoveAsync(db, TrashEntityKind.Chapter, id, ct);
foreach (var id in locationIds)
await TrashPurge.RemoveAsync(db, TrashEntityKind.Location, id, ct);
await db.SaveChangesAsync(ct);
return (characterIds.Count, chapterIds.Count, locationIds.Count);
}
}
@@ -0,0 +1,11 @@
namespace Novelly.Api.Trash;
public static class TrashPurgeSchedule
{
public static DateTimeOffset NextRunAfter(DateTimeOffset now, TimeOnly runAt)
{
var candidate = new DateTimeOffset(now.Year, now.Month, now.Day, runAt.Hour, runAt.Minute, runAt.Second, now.Offset);
return candidate > now ? candidate : candidate.AddDays(1);
}
}
+186
View File
@@ -0,0 +1,186 @@
using Microsoft.EntityFrameworkCore;
using Microsoft.Extensions.Options;
using Novelly.Api.Activity;
using Novelly.Api.Common;
using Novelly.Api.Data;
using Novelly.Api.Users;
namespace Novelly.Api.Trash;
public class TrashService(
INovelDbContext db,
NovelAccessService access,
ActivityLog activity,
IOptions<TrashOptions> options,
ILogger<TrashService> logger)
{
public async Task<IReadOnlyList<TrashedItemResponse>> ListAsync(Guid novelId, CancellationToken ct = default)
{
Guard.Default(novelId, nameof(novelId));
logger.LogInformation("Listing trash for novel {NovelId}", novelId);
await access.RequireAsync(novelId, NovelPermission.Read, ct);
var retentionDays = options.Value.RetentionDays;
var characters = await db.Characters
.IgnoreQueryFilters()
.Where(c => c.NovelId == novelId && c.DeletedAt != null)
.Select(c => new TrashedItemResponse(
c.Id, TrashEntityKind.Character, c.Name,
c.ArcStages.Count > 0 ? $"{c.ArcStages.Count} arc stages" : null,
c.DeletedAt!.Value, c.DeletedAt!.Value.AddDays(retentionDays)))
.ToListAsync(ct);
var chapters = await db.Chapters
.IgnoreQueryFilters()
.Where(c => c.NovelId == novelId && c.DeletedAt != null)
.Select(c => new TrashedItemResponse(
c.Id, TrashEntityKind.Chapter, c.Title,
c.Beats.Count > 0 ? $"{c.Beats.Count} beats" : null,
c.DeletedAt!.Value, c.DeletedAt!.Value.AddDays(retentionDays)))
.ToListAsync(ct);
var locations = await db.Locations
.IgnoreQueryFilters()
.Where(l => l.NovelId == novelId && l.DeletedAt != null)
.Select(l => new TrashedItemResponse(
l.Id, TrashEntityKind.Location, l.Name,
l.Chapters.Count > 0 ? $"used by {l.Chapters.Count} chapters" : null,
l.DeletedAt!.Value, l.DeletedAt!.Value.AddDays(retentionDays)))
.ToListAsync(ct);
return [.. characters.Concat(chapters).Concat(locations).OrderByDescending(i => i.DeletedAt)];
}
public async Task<bool> RestoreAsync(TrashEntityKind kind, Guid id, CancellationToken ct = default)
{
Guard.Default(id, nameof(id));
logger.LogInformation("Restoring {Kind} {ItemId} from trash", kind, id);
return kind switch
{
TrashEntityKind.Character => await RestoreCharacterAsync(id, ct),
TrashEntityKind.Chapter => await RestoreChapterAsync(id, ct),
TrashEntityKind.Location => await RestoreLocationAsync(id, ct),
_ => throw new ArgumentOutOfRangeException(nameof(kind), kind, null)
};
}
public async Task<bool> PurgeAsync(TrashEntityKind kind, Guid id, CancellationToken ct = default)
{
Guard.Default(id, nameof(id));
logger.LogInformation("Purging {Kind} {ItemId} from trash", kind, id);
var novelId = await NovelIdOfTrashedAsync(kind, id, ct);
if (novelId is null)
{
return false;
}
await access.RequireAsync(novelId.Value, NovelPermission.DeleteContent, ct);
var removed = await TrashPurge.RemoveAsync(db, kind, id, ct);
if (!removed)
{
return false;
}
await db.SaveChangesAsync(ct);
return true;
}
public async Task<int> EmptyAsync(Guid novelId, CancellationToken ct = default)
{
Guard.Default(novelId, nameof(novelId));
logger.LogInformation("Emptying trash for novel {NovelId}", novelId);
await access.RequireAsync(novelId, NovelPermission.DeleteContent, ct);
var items = await ListAsync(novelId, ct);
var purged = 0;
foreach (var item in items)
{
if (await TrashPurge.RemoveAsync(db, item.Kind, item.Id, ct))
{
purged++;
}
}
await db.SaveChangesAsync(ct);
logger.LogInformation("Emptied {Count} items from trash for novel {NovelId}", purged, novelId);
return purged;
}
private async Task<bool> RestoreCharacterAsync(Guid id, CancellationToken ct)
{
var character = await db.Characters.IgnoreQueryFilters().FirstOrDefaultAsync(c => c.Id == id && c.DeletedAt != null, ct);
if (character is null)
{
logger.LogWarning("Trashed character {CharacterId} not found", id);
return false;
}
await access.RequireAsync(character.NovelId, NovelPermission.DeleteContent, ct);
character.DeletedAt = null;
activity.Record(character.NovelId, ActivityEntityKind.Character, ActivityAction.Restored, character.Id);
await db.SaveChangesAsync(ct);
return true;
}
private async Task<bool> RestoreChapterAsync(Guid id, CancellationToken ct)
{
var chapter = await db.Chapters.IgnoreQueryFilters().FirstOrDefaultAsync(c => c.Id == id && c.DeletedAt != null, ct);
if (chapter is null)
{
logger.LogWarning("Trashed chapter {ChapterId} not found", id);
return false;
}
await access.RequireAsync(chapter.NovelId, NovelPermission.DeleteContent, ct);
chapter.DeletedAt = null;
activity.Record(chapter.NovelId, ActivityEntityKind.Chapter, ActivityAction.Restored, chapter.Id, chapter.WordCount);
await db.SaveChangesAsync(ct);
return true;
}
private async Task<bool> RestoreLocationAsync(Guid id, CancellationToken ct)
{
var location = await db.Locations.IgnoreQueryFilters().FirstOrDefaultAsync(l => l.Id == id && l.DeletedAt != null, ct);
if (location is null)
{
logger.LogWarning("Trashed location {LocationId} not found", id);
return false;
}
await access.RequireAsync(location.NovelId, NovelPermission.DeleteContent, ct);
var clash = await db.Locations.FirstOrDefaultAsync(
l => l.NovelId == location.NovelId && EF.Functions.Like(l.Name, location.Name), ct);
if (clash is not null)
{
logger.LogWarning("Rejected restore of location {LocationId}: '{Name}' already exists as {ClashLocationId}", id, location.Name, clash.Id);
throw new InvalidOperationException($"The novel already has a location called '{clash.Name}'.");
}
location.DeletedAt = null;
activity.Record(location.NovelId, ActivityEntityKind.Location, ActivityAction.Restored, location.Id);
await db.SaveChangesAsync(ct);
return true;
}
private async Task<Guid?> NovelIdOfTrashedAsync(TrashEntityKind kind, Guid id, CancellationToken ct) => kind switch
{
TrashEntityKind.Character => (await db.Characters.IgnoreQueryFilters().Where(c => c.Id == id && c.DeletedAt != null).Select(c => (Guid?)c.NovelId).FirstOrDefaultAsync(ct)),
TrashEntityKind.Chapter => (await db.Chapters.IgnoreQueryFilters().Where(c => c.Id == id && c.DeletedAt != null).Select(c => (Guid?)c.NovelId).FirstOrDefaultAsync(ct)),
TrashEntityKind.Location => (await db.Locations.IgnoreQueryFilters().Where(l => l.Id == id && l.DeletedAt != null).Select(l => (Guid?)l.NovelId).FirstOrDefaultAsync(ct)),
_ => throw new ArgumentOutOfRangeException(nameof(kind), kind, null)
};
}
@@ -15,5 +15,8 @@
"Microsoft.AspNetCore.Diagnostics.ExceptionHandlerMiddleware": "Fatal" "Microsoft.AspNetCore.Diagnostics.ExceptionHandlerMiddleware": "Fatal"
} }
} }
},
"Imports": {
"RootPath": "../../imports"
} }
} }
+12 -1
View File
@@ -28,9 +28,20 @@
"Origins": [ "http://localhost:5173" ] "Origins": [ "http://localhost:5173" ]
}, },
"Agent": { "Agent": {
"Model": "claude-opus-5", "Model": "claude-sonnet-5",
"MaxTokens": 16000, "MaxTokens": 16000,
"Effort": "high", "Effort": "high",
"MaxIterations": 12 "MaxIterations": 12
},
"UiSettings": {
"ShowPronouns": false
},
"Imports": {
"RootPath": null
},
"Trash": {
"Enabled": true,
"RetentionDays": 30,
"PurgeAtLocalTime": "02:00"
} }
} }
-101
View File
@@ -1,101 +0,0 @@
using System.Net;
using System.Net.Http.Json;
using System.Text.Json;
using Microsoft.Extensions.Logging;
using ModelContextProtocol.Protocol;
namespace Novelly.Mcp;
public class NovelApiClient(HttpClient http, ILogger<NovelApiClient> logger)
{
private static readonly JsonSerializerOptions Options = new(JsonSerializerDefaults.Web)
{
WriteIndented = true
};
public Task<CallToolResult> GetAsync(string path, CancellationToken ct = default) => SendAsync(new HttpRequestMessage(HttpMethod.Get, path), ct);
public Task<CallToolResult> PostAsync(string path, object body, CancellationToken ct = default) =>
SendAsync(new HttpRequestMessage(HttpMethod.Post, path)
{
Content = JsonContent.Create(body, options: Options)
}, ct);
public Task<CallToolResult> PatchAsync(string path, object body, CancellationToken ct = default) =>
SendAsync(new HttpRequestMessage(HttpMethod.Patch, path)
{
Content = JsonContent.Create(body, options: Options)
}, ct);
public Task<CallToolResult> PutAsync(string path, object body, CancellationToken ct = default) =>
SendAsync(new HttpRequestMessage(HttpMethod.Put, path)
{
Content = JsonContent.Create(body, options: Options)
}, ct);
public Task<CallToolResult> DeleteAsync(string path, CancellationToken ct = default) => SendAsync(new HttpRequestMessage(HttpMethod.Delete, path), ct);
private async Task<CallToolResult> SendAsync(HttpRequestMessage request, CancellationToken ct)
{
HttpResponseMessage response;
try
{
response = await http.SendAsync(request, ct);
}
catch (HttpRequestException ex)
{
logger.LogError(ex, "Could not reach the Novelly API at {BaseAddress}", http.BaseAddress);
return Error($"Could not reach the Novelly API at {http.BaseAddress}. Is it running? ({ex.Message})");
}
var body = await response.Content.ReadAsStringAsync(ct);
if (response.IsSuccessStatusCode)
{
return Ok(string.IsNullOrWhiteSpace(body) ? "{\"ok\":true}" : Prettify(body));
}
var detail = TryReadProblemDetail(body) ?? body;
return Error(response.StatusCode switch
{
HttpStatusCode.Unauthorized => $"Not permitted: the Novelly API rejected the service api key. Set NOVELLY_API_KEY to match the API's Auth:ServiceApiKey. ({detail})",
HttpStatusCode.Forbidden => $"Not permitted: {detail}",
HttpStatusCode.NotFound => $"Not found: {detail}",
HttpStatusCode.BadRequest => $"Rejected: {detail}",
_ => $"API returned {(int)response.StatusCode}: {detail}"
});
}
private static CallToolResult Ok(string text) =>
new() { Content = [new TextContentBlock { Text = text }] };
private static CallToolResult Error(string message) =>
new() { Content = [new TextContentBlock { Text = message }], IsError = true };
private string Prettify(string json)
{
try
{
return JsonSerializer.Serialize(JsonSerializer.Deserialize<JsonElement>(json), Options);
}
catch (JsonException ex)
{
logger.LogWarning(ex, "Response body was not valid JSON; returning it unformatted");
return json;
}
}
private string? TryReadProblemDetail(string body)
{
try
{
var problem = JsonSerializer.Deserialize<JsonElement>(body);
return problem.TryGetProperty("detail", out var detail) ? detail.GetString() : null;
}
catch (JsonException ex)
{
logger.LogWarning(ex, "Error response body was not valid JSON problem details");
return null;
}
}
}
-17
View File
@@ -1,17 +0,0 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<OutputType>Exe</OutputType>
<TargetFramework>net10.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
<LangVersion>latest</LangVersion>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Microsoft.Extensions.Hosting" Version="10.0.10" />
<PackageReference Include="Microsoft.Extensions.Http" Version="10.0.10" />
<PackageReference Include="ModelContextProtocol" Version="2.1.0" />
</ItemGroup>
</Project>
-31
View File
@@ -1,31 +0,0 @@
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;
using Novelly.Mcp;
var builder = Host.CreateApplicationBuilder(args);
builder.Logging.ClearProviders();
builder.Logging.AddConsole(options => options.LogToStandardErrorThreshold = LogLevel.Trace);
builder.Logging.SetMinimumLevel(LogLevel.Warning);
var apiBaseUrl = builder.Configuration["NOVELLY_API_URL"] ?? "http://localhost:5080";
var apiKey = builder.Configuration["NOVELLY_API_KEY"];
builder.Services.AddHttpClient<NovelApiClient>(client =>
{
client.BaseAddress = new Uri(apiBaseUrl);
client.Timeout = TimeSpan.FromSeconds(30);
if (!string.IsNullOrWhiteSpace(apiKey))
{
client.DefaultRequestHeaders.Add("X-Novelly-Api-Key", apiKey);
}
});
builder.Services
.AddMcpServer()
.WithStdioServerTransport()
.WithToolsFromAssembly();
await builder.Build().RunAsync();
-92
View File
@@ -1,92 +0,0 @@
using System.ComponentModel;
using ModelContextProtocol.Protocol;
using ModelContextProtocol.Server;
namespace Novelly.Mcp.Tools;
[McpServerToolType]
public static class BeatTools
{
[McpServerTool(Name = "get_chapter_outline")]
[Description("Read a chapter's outline: its beats in order. Each beat is one row — a short "
+ "title, who it belongs to, what happened, and what it sets up. The chapter's "
+ "summary paragraph and drafted prose sit on the chapter itself, via get_chapter.")]
public static Task<CallToolResult> GetChapterOutline(
NovelApiClient api,
[Description("The chapter's id.")] Guid chapterId,
CancellationToken ct) =>
api.GetAsync($"/api/chapters/{chapterId}/beats", ct);
[McpServerTool(Name = "create_beat")]
[Description("Add a beat to a chapter's outline. Keep the title to three to five words — it "
+ "is a handle, not a sentence; detail belongs in whatHappened and whatsNext.")]
public static Task<CallToolResult> CreateBeat(
NovelApiClient api,
[Description("The chapter's id.")] Guid chapterId,
[Description("Three to five words naming the beat.")] string title,
CancellationToken ct,
[Description("Position in the chapter. Appended to the end when omitted.")] int? sortOrder = null,
[Description("Ids of the characters whose beat this is.")] Guid[]? characterIds = null,
[Description("The event itself.")] string? whatHappened = null,
[Description("What it sets in motion — the hook into the next beat.")] string? whatsNext = null,
[Description("Tags for cross-referencing. Unknown tags are created.")] string[]? tags = null) =>
api.PostAsync($"/api/chapters/{chapterId}/beats",
new { title, sortOrder, characterIds, whatHappened, whatsNext, tags }, ct);
[McpServerTool(Name = "update_beat")]
[Description("Revise a beat. Only the fields you supply change. Supplying a characterIds or "
+ "tag list replaces the beat's characters or tags outright — pass an empty list "
+ "to clear one, and include everything you want to keep.")]
public static Task<CallToolResult> UpdateBeat(
NovelApiClient api,
[Description("The beat's id.")] Guid beatId,
CancellationToken ct,
[Description("Three to five words naming the beat.")] string? title = null,
[Description("Position in the chapter.")] int? sortOrder = null,
[Description("Ids of the characters whose beat this is. Replaces the existing list.")] Guid[]? characterIds = null,
[Description("The event itself.")] string? whatHappened = null,
[Description("What it sets in motion.")] string? whatsNext = null,
[Description("Tags for cross-referencing. Replaces the existing tags.")] string[]? tags = null) =>
api.PatchAsync($"/api/beats/{beatId}",
new { title, sortOrder, characterIds, whatHappened, whatsNext, tags }, ct);
[McpServerTool(Name = "delete_beat")]
[Description("Remove a beat from a chapter's outline. Confirm with the writer first.")]
public static Task<CallToolResult> DeleteBeat(
NovelApiClient api,
[Description("The beat's id.")] Guid beatId,
CancellationToken ct) =>
api.DeleteAsync($"/api/beats/{beatId}", ct);
[McpServerTool(Name = "assign_character_to_beats")]
[Description("Add a character to several beats at once. Leaves each beat's existing characters "
+ "and other fields alone — this only adds, it never removes.")]
public static Task<CallToolResult> AssignCharacterToBeats(
NovelApiClient api,
[Description("The chapter's id.")] Guid chapterId,
[Description("Id of the character to add.")] Guid characterId,
[Description("Ids of the beats to add the character to.")] Guid[] beatIds,
CancellationToken ct) =>
api.PostAsync($"/api/chapters/{chapterId}/beats/assign-character", new { characterId, beatIds }, ct);
[McpServerTool(Name = "reorder_beats")]
[Description("Renumber a chapter's beats to match the order given. List every beat id in the "
+ "order wanted; any left out keep their relative position at the end.")]
public static Task<CallToolResult> ReorderBeats(
NovelApiClient api,
[Description("The chapter's id.")] Guid chapterId,
[Description("Beat ids in their new order.")] Guid[] beatIds,
CancellationToken ct) =>
api.PostAsync($"/api/chapters/{chapterId}/beats/reorder", new { beatIds }, ct);
[McpServerTool(Name = "move_beats")]
[Description("Move one or more beats from one chapter to another, appending them to the "
+ "target chapter's end in the order given.")]
public static Task<CallToolResult> MoveBeats(
NovelApiClient api,
[Description("The beats' current chapter id.")] Guid chapterId,
[Description("Id of the chapter to move the beats into.")] Guid targetChapterId,
[Description("Ids of the beats to move.")] Guid[] beatIds,
CancellationToken ct) =>
api.PostAsync($"/api/chapters/{chapterId}/beats/move", new { targetChapterId, beatIds }, ct);
}
-238
View File
@@ -1,238 +0,0 @@
using System.ComponentModel;
using ModelContextProtocol.Protocol;
using ModelContextProtocol.Server;
namespace Novelly.Mcp.Tools;
[McpServerToolType]
public static class CharacterTools
{
[McpServerTool(Name = "list_characters")]
[Description("List a novel's character dossiers in full, including their relationships.")]
public static Task<CallToolResult> ListCharacters(
NovelApiClient api,
[Description("The novel's id.")] Guid novelId,
CancellationToken ct) =>
api.GetAsync($"/api/novels/{novelId}/characters", ct);
[McpServerTool(Name = "get_character")]
[Description("Read one character's dossier.")]
public static Task<CallToolResult> GetCharacter(
NovelApiClient api,
[Description("The character's id.")] Guid characterId,
CancellationToken ct) =>
api.GetAsync($"/api/characters/{characterId}", ct);
[McpServerTool(Name = "create_character")]
[Description("Add a character dossier to a novel. Name is the only requirement — leave a field "
+ "blank when the writer has not decided it yet rather than inventing detail.")]
public static Task<CallToolResult> CreateCharacter(
NovelApiClient api,
[Description("The novel's id.")] Guid novelId,
[Description("The character's name.")] string name,
CancellationToken ct,
[Description("Protagonist, Antagonist, Deuteragonist, Supporting, Minor, Mentor, LoveInterest or Foil.")]
string? role = null,
[Description("Main or Supporting. Main characters are the few the story is about and are worth tracking an arc for.")]
string? importance = null,
[Description("Age, exact or approximate.")] string? age = null,
[Description("The pronouns this character uses.")] string? pronouns = null,
[Description("What they do.")] string? occupation = null,
[Description("How they look.")] string? appearance = null,
[Description("Temperament, habits, how they treat people.")] string? personality = null,
[Description("History that shapes who they are now.")] string? backstory = null,
[Description("What they consciously pursue.")] string? want = null,
[Description("What they actually need, usually at odds with what they want.")] string? need = null,
[Description("The war inside them.")] string? internalConflict = null,
[Description("What in the world opposes them.")] string? externalConflict = null,
[Description("How they change over the course of the book.")] string? arcSummary = null,
[Description("Speech patterns and register that make their dialogue theirs.")] string? voice = null,
[Description("Anything else worth recording.")] string? notes = null,
[Description("Tags for cross-referencing. Unknown tags are created.")] string[]? tags = null,
[Description("Other names this character is known by.")] string[]? aliases = null) =>
api.PostAsync($"/api/novels/{novelId}/characters", new
{
name,
role = role ?? "Supporting",
importance = importance ?? "Supporting",
age,
pronouns,
occupation,
appearance,
personality,
backstory,
want,
need,
internalConflict,
externalConflict,
arcSummary,
voice,
notes,
tags,
aliases
}, ct);
[McpServerTool(Name = "update_character")]
[Description("Revise an existing character dossier. Only the fields you supply change.")]
public static Task<CallToolResult> UpdateCharacter(
NovelApiClient api,
[Description("The character's id.")] Guid characterId,
CancellationToken ct,
[Description("New name.")] string? name = null,
[Description("Protagonist, Antagonist, Deuteragonist, Supporting, Minor, Mentor, LoveInterest or Foil.")]
string? role = null,
[Description("Main or Supporting. Main characters are the few the story is about and are worth tracking an arc for.")]
string? importance = null,
[Description("Age, exact or approximate.")] string? age = null,
[Description("The pronouns this character uses.")] string? pronouns = null,
[Description("What they do.")] string? occupation = null,
[Description("How they look.")] string? appearance = null,
[Description("Temperament, habits, how they treat people.")] string? personality = null,
[Description("History that shapes who they are now.")] string? backstory = null,
[Description("What they consciously pursue.")] string? want = null,
[Description("What they actually need.")] string? need = null,
[Description("The war inside them.")] string? internalConflict = null,
[Description("What in the world opposes them.")] string? externalConflict = null,
[Description("How they change over the course of the book.")] string? arcSummary = null,
[Description("Speech patterns and register.")] string? voice = null,
[Description("Anything else worth recording.")] string? notes = null,
[Description("Tags for cross-referencing. Replaces the existing tags.")] string[]? tags = null,
[Description("Other names this character is known by. Replaces the existing aliases.")] string[]? aliases = null) =>
api.PatchAsync($"/api/characters/{characterId}", new
{
name,
role,
importance,
age,
pronouns,
occupation,
appearance,
personality,
backstory,
want,
need,
internalConflict,
externalConflict,
arcSummary,
voice,
notes,
tags,
aliases
}, ct);
[McpServerTool(Name = "get_character_beats")]
[Description("Every beat this character appears in, across the whole book, in manuscript order. "
+ "This is what the character actually does on the page, as opposed to what the "
+ "dossier claims about them — read it before revising a character.")]
public static Task<CallToolResult> GetCharacterBeats(
NovelApiClient api,
[Description("The character's id.")] Guid characterId,
CancellationToken ct) =>
api.GetAsync($"/api/characters/{characterId}/beats", ct);
[McpServerTool(Name = "get_character_arc")]
[Description("Read a main character's arc: the ordered stages of how they change, each "
+ "optionally pinned to the chapter where it lands.")]
public static Task<CallToolResult> GetCharacterArc(
NovelApiClient api,
[Description("The character's id.")] Guid characterId,
CancellationToken ct) =>
api.GetAsync($"/api/characters/{characterId}/arc", ct);
[McpServerTool(Name = "add_arc_stage")]
[Description("Add a stage to a character's arc. Arcs are kept for main characters — promote "
+ "the character with update_character first if they are still Supporting.")]
public static Task<CallToolResult> AddArcStage(
NovelApiClient api,
[Description("Id of the character whose arc to add to.")] Guid characterId,
[Description("A short handle for the change, three to five words.")] string title,
CancellationToken ct,
[Description("What this stage of the arc results in for the character — what shifts, and what it costs them.")] string? result = null,
[Description("Id of the chapter where this stage lands, if it is pinned to one.")] Guid? chapterId = null,
[Description("Position in the arc. Appended to the end when omitted.")] int? sortOrder = null) =>
api.PostAsync($"/api/characters/{characterId}/arc",
new { title, sortOrder, result, chapterId }, ct);
[McpServerTool(Name = "update_arc_stage")]
[Description("Revise a stage of a character's arc. Only the fields you supply change.")]
public static Task<CallToolResult> UpdateArcStage(
NovelApiClient api,
[Description("The arc stage's id.")] Guid arcStageId,
CancellationToken ct,
[Description("New title for the stage.")] string? title = null,
[Description("What this stage of the arc results in for the character.")] string? result = null,
[Description("Id of the chapter where this stage lands.")] Guid? chapterId = null,
[Description("Position in the arc.")] int? sortOrder = null) =>
api.PatchAsync($"/api/arc-stages/{arcStageId}",
new { title, sortOrder, result, chapterId }, ct);
[McpServerTool(Name = "delete_arc_stage")]
[Description("Remove a stage from a character's arc.")]
public static Task<CallToolResult> DeleteArcStage(
NovelApiClient api,
[Description("The arc stage's id.")] Guid arcStageId,
CancellationToken ct) =>
api.DeleteAsync($"/api/arc-stages/{arcStageId}", ct);
[McpServerTool(Name = "reorder_arc_stages")]
[Description("Renumber a character's arc to match the order given. Stages left out keep their "
+ "relative position after the ones listed.")]
public static Task<CallToolResult> ReorderArcStages(
NovelApiClient api,
[Description("Id of the character whose arc to reorder.")] Guid characterId,
[Description("Arc stage ids in the order wanted.")] string[] stageIds,
CancellationToken ct) =>
api.PostAsync($"/api/characters/{characterId}/arc/reorder", new { stageIds }, ct);
[McpServerTool(Name = "set_arc_stage_beats")]
[Description("Set which beats belong to an arc stage, replacing its current set. This groups the "
+ "chapter-level beats that establish or pay off this stage of the character's arc. A "
+ "beat moved into this stage leaves any other stage of the same character it was in. "
+ "Each beat must already include this character.")]
public static Task<CallToolResult> SetArcStageBeats(
NovelApiClient api,
[Description("The arc stage's id.")] Guid arcStageId,
[Description("Beat ids that belong to this stage, replacing whatever was there before.")] string[] beatIds,
CancellationToken ct) =>
api.PostAsync($"/api/arc-stages/{arcStageId}/beats", new { beatIds }, ct);
[McpServerTool(Name = "relate_characters")]
[Description("Record a relationship between two characters in the same novel. Creates both directions "
+ "at once — characterId's side and relatedCharacterId's side — so the pair always shows up "
+ "on both dossiers.")]
public static Task<CallToolResult> RelateCharacters(
NovelApiClient api,
[Description("Id of the character the relationship belongs to.")] Guid characterId,
[Description("Id of the character they are related to.")] Guid relatedCharacterId,
[Description("How characterId is related to relatedCharacterId, e.g. 'sister', 'rival', 'former mentor'.")] string relationshipType,
CancellationToken ct,
[Description("How relatedCharacterId is related back to characterId, if different — e.g. 'brother' for "
+ "'sister'. Defaults to relationshipType when the relation is symmetric, like 'rival'.")]
string? reciprocalRelationshipType = null,
[Description("What the relationship is like, and where it is headed.")] string? description = null) =>
api.PostAsync($"/api/characters/{characterId}/relationships",
new { relatedCharacterId, relationshipType, reciprocalRelationshipType, description }, ct);
[McpServerTool(Name = "link_character_identity")]
[Description("Record that this character is really another character — e.g. a character introduced "
+ "under one name who is later revealed to be a character already in the novel under "
+ "another name. Both characters keep their own dossier and beats; the canonical identity "
+ "is whichever character you link to.")]
public static Task<CallToolResult> LinkCharacterIdentity(
NovelApiClient api,
[Description("Id of the character being revealed as someone else.")] Guid characterId,
[Description("Id of the character this one really is.")] Guid sameCharacterAsId,
CancellationToken ct,
[Description("Id of the chapter where the reveal happens, if any.")] Guid? revealedInChapterId = null,
[Description("Context on the reveal, e.g. how and why the disguise held.")] string? note = null) =>
api.PutAsync($"/api/characters/{characterId}/identity",
new { sameCharacterAsId, revealedInChapterId, note }, ct);
[McpServerTool(Name = "unlink_character_identity")]
[Description("Remove a character's identity link, restoring it to its own separate identity.")]
public static Task<CallToolResult> UnlinkCharacterIdentity(
NovelApiClient api,
[Description("The character's id.")] Guid characterId,
CancellationToken ct) =>
api.DeleteAsync($"/api/characters/{characterId}/identity", ct);
}
-53
View File
@@ -1,53 +0,0 @@
using System.ComponentModel;
using ModelContextProtocol.Protocol;
using ModelContextProtocol.Server;
namespace Novelly.Mcp.Tools;
[McpServerToolType]
public static class LocationTools
{
[McpServerTool(Name = "list_locations")]
[Description("List a novel's locations with how many chapters are set there. "
+ "Read this before inventing a new location so you reuse the writer's vocabulary.")]
public static Task<CallToolResult> ListLocations(
NovelApiClient api,
[Description("The novel's id.")] Guid novelId,
CancellationToken ct) =>
api.GetAsync($"/api/novels/{novelId}/locations", ct);
[McpServerTool(Name = "get_location_references")]
[Description("Cross-reference a location: every chapter set there.")]
public static Task<CallToolResult> GetLocationReferences(
NovelApiClient api,
[Description("The location's id.")] Guid locationId,
CancellationToken ct) =>
api.GetAsync($"/api/locations/{locationId}/references", ct);
[McpServerTool(Name = "create_location")]
[Description("Create a location explicitly. Applying an unknown location by name to a chapter "
+ "also creates it, so this is only needed to set one up ahead of time.")]
public static Task<CallToolResult> CreateLocation(
NovelApiClient api,
[Description("The novel's id.")] Guid novelId,
[Description("The location's name. Unique within the novel, matched case-insensitively.")] string name,
CancellationToken ct) =>
api.PostAsync($"/api/novels/{novelId}/locations", new { name }, ct);
[McpServerTool(Name = "update_location")]
[Description("Rename a location. Renaming updates it everywhere it is applied.")]
public static Task<CallToolResult> UpdateLocation(
NovelApiClient api,
[Description("The location's id.")] Guid locationId,
[Description("New name.")] string name,
CancellationToken ct) =>
api.PatchAsync($"/api/locations/{locationId}", new { name }, ct);
[McpServerTool(Name = "delete_location")]
[Description("Delete a location. Whatever carried it is left alone — only the label goes.")]
public static Task<CallToolResult> DeleteLocation(
NovelApiClient api,
[Description("The location's id.")] Guid locationId,
CancellationToken ct) =>
api.DeleteAsync($"/api/locations/{locationId}", ct);
}
-71
View File
@@ -1,71 +0,0 @@
using System.ComponentModel;
using ModelContextProtocol.Protocol;
using ModelContextProtocol.Server;
namespace Novelly.Mcp.Tools;
[McpServerToolType]
public static class ManuscriptTools
{
[McpServerTool(Name = "list_chapters")]
[Description("List a novel's chapters in manuscript order, with beat and word counts.")]
public static Task<CallToolResult> ListChapters(
NovelApiClient api,
[Description("The novel's id.")] Guid novelId,
CancellationToken ct) =>
api.GetAsync($"/api/novels/{novelId}/chapters", ct);
[McpServerTool(Name = "get_chapter")]
[Description("Read one chapter in full: its outline (beats) and its drafted prose.")]
public static Task<CallToolResult> GetChapter(
NovelApiClient api,
[Description("The chapter's id.")] Guid chapterId,
CancellationToken ct) =>
api.GetAsync($"/api/chapters/{chapterId}", ct);
[McpServerTool(Name = "create_chapter")]
[Description("Add a chapter to a novel. It goes at the end of the manuscript unless you supply a number.")]
public static Task<CallToolResult> CreateChapter(
NovelApiClient api,
[Description("The novel's id.")] Guid novelId,
[Description("Chapter title.")] string title,
CancellationToken ct,
[Description("Position in the manuscript, 1-based.")] int? number = null,
[Description("The chapter's outline summary paragraph.")] string? summary = null,
[Description("Where and when the chapter takes place. Unknown locations are created.")] string[]? locations = null,
[Description("Planned, Outlined, Drafted, Revised or Final.")] string? status = null,
[Description("Target length in words.")] int? targetWordCount = null,
[Description("The chapter's drafted text, in markdown, if you are writing it now.")] string? prose = null,
[Description("Tags for cross-referencing. Unknown tags are created.")] string[]? tags = null) =>
api.PostAsync($"/api/novels/{novelId}/chapters", new
{
title,
number,
summary,
locations,
status = status ?? "Planned",
targetWordCount,
prose,
tags
}, ct);
[McpServerTool(Name = "update_chapter")]
[Description("Revise a chapter's title, number, summary, locations, notes, status "
+ "or drafted prose. Use 'prose' to write or replace the chapter's draft text in "
+ "markdown; the word count is recomputed automatically.")]
public static Task<CallToolResult> UpdateChapter(
NovelApiClient api,
[Description("The chapter's id.")] Guid chapterId,
CancellationToken ct,
[Description("New title.")] string? title = null,
[Description("Position in the manuscript.")] int? number = null,
[Description("The chapter's outline summary paragraph.")] string? summary = null,
[Description("Where and when the chapter takes place. Replaces the existing locations. Unknown locations are created.")] string[]? locations = null,
[Description("Anything else worth recording.")] string? notes = null,
[Description("Planned, Outlined, Drafted, Revised or Final.")] string? status = null,
[Description("Target length in words.")] int? targetWordCount = null,
[Description("The chapter's drafted text, in markdown.")] string? prose = null,
[Description("Tags for cross-referencing. Replaces the existing tags.")] string[]? tags = null) =>
api.PatchAsync($"/api/chapters/{chapterId}",
new { title, number, summary, locations, notes, status, targetWordCount, prose, tags }, ct);
}
-54
View File
@@ -1,54 +0,0 @@
using System.ComponentModel;
using ModelContextProtocol.Protocol;
using ModelContextProtocol.Server;
namespace Novelly.Mcp.Tools;
[McpServerToolType]
public static class NovelTools
{
[McpServerTool(Name = "list_novels")]
[Description("List every novel, with counts of characters, chapters and drafted words. "
+ "Start here to find the novel id everything else needs.")]
public static Task<CallToolResult> ListNovels(NovelApiClient api, CancellationToken ct) =>
api.GetAsync("/api/novels", ct);
[McpServerTool(Name = "get_novel_brief")]
[Description("Read a novel's title, author, genre, logline, synopsis, notes and word-count target.")]
public static Task<CallToolResult> GetNovel(
NovelApiClient api,
[Description("The novel's id.")] Guid novelId,
CancellationToken ct) =>
api.GetAsync($"/api/novels/{novelId}", ct);
[McpServerTool(Name = "create_novel")]
[Description("Create a new novel.")]
public static Task<CallToolResult> CreateNovel(
NovelApiClient api,
[Description("Working title.")] string title,
CancellationToken ct,
[Description("Author name.")] string? author = null,
[Description("Genre or category.")] string? genre = null,
[Description("One-sentence pitch.")] string? logline = null,
[Description("Paragraph-length summary of the whole book.")] string? synopsis = null,
[Description("Free-form notes on theme, tone, comparable titles.")] string? notes = null,
[Description("Target manuscript length in words.")] int? targetWordCount = null) =>
api.PostAsync("/api/novels", new { title, author, genre, logline, synopsis, notes, targetWordCount }, ct);
[McpServerTool(Name = "update_novel_brief")]
[Description("Revise a novel's top-level fields. Only the fields you supply change; "
+ "pass an empty string to clear one.")]
public static Task<CallToolResult> UpdateNovel(
NovelApiClient api,
[Description("The novel's id.")] Guid novelId,
CancellationToken ct,
[Description("New title.")] string? title = null,
[Description("Author name.")] string? author = null,
[Description("Genre or category.")] string? genre = null,
[Description("One-sentence pitch.")] string? logline = null,
[Description("Paragraph-length summary of the whole book.")] string? synopsis = null,
[Description("Free-form notes on theme, tone, comparable titles.")] string? notes = null,
[Description("Target manuscript length in words.")] int? targetWordCount = null) =>
api.PatchAsync($"/api/novels/{novelId}",
new { title, author, genre, logline, synopsis, notes, targetWordCount }, ct);
}
-92
View File
@@ -1,92 +0,0 @@
using System.ComponentModel;
using ModelContextProtocol.Protocol;
using ModelContextProtocol.Server;
namespace Novelly.Mcp.Tools;
[McpServerToolType]
public static class QuestionTools
{
[McpServerTool(Name = "list_open_questions")]
[Description("The decisions the writer has not made yet, newest first. Read this before "
+ "proposing changes — an open question marks somewhere the writer is still "
+ "thinking, not a gap to fill in for them.")]
public static Task<CallToolResult> ListOpenQuestions(
NovelApiClient api,
[Description("The novel's id.")] Guid novelId,
CancellationToken ct,
[Description("Narrow to questions about one chapter outline.")] Guid? chapterId = null,
[Description("Narrow to questions about one character.")] Guid? characterId = null,
[Description("Include questions already settled. Defaults to false.")] bool includeResolved = false)
{
var query = new List<string> { $"includeResolved={includeResolved.ToString().ToLowerInvariant()}" };
if (chapterId is { } chapter)
{
query.Add($"chapterId={chapter}");
}
if (characterId is { } character)
{
query.Add($"characterId={character}");
}
return api.GetAsync($"/api/novels/{novelId}/questions?{string.Join('&', query)}", ct);
}
[McpServerTool(Name = "raise_open_question")]
[Description("Record a question the writer has not settled, attached to the chapter outline "
+ "and/or the character it is about. Prefer raising a question over guessing.")]
public static Task<CallToolResult> RaiseOpenQuestion(
NovelApiClient api,
[Description("The novel's id.")] Guid novelId,
[Description("The question, in one line.")] string question,
CancellationToken ct,
[Description("The thinking around it — options considered, and what each costs.")] string? detail = null,
[Description("Id of the chapter outline this is about, if any.")] Guid? chapterId = null,
[Description("Id of the character this is about, if any.")] Guid? characterId = null) =>
api.PostAsync($"/api/novels/{novelId}/questions",
new { question, detail, chapterId, characterId }, ct);
[McpServerTool(Name = "update_open_question")]
[Description("Revise a question or change what it is attached to. Only the fields you supply change.")]
public static Task<CallToolResult> UpdateOpenQuestion(
NovelApiClient api,
[Description("The question's id.")] Guid questionId,
CancellationToken ct,
[Description("New wording for the question.")] string? question = null,
[Description("New detail. Pass an empty string to clear it.")] string? detail = null,
[Description("Attach to this chapter outline.")] Guid? chapterId = null,
[Description("Attach to this character.")] Guid? characterId = null,
[Description("Detach from its chapter.")] bool clearChapter = false,
[Description("Detach from its character.")] bool clearCharacter = false) =>
api.PatchAsync($"/api/questions/{questionId}",
new { question, detail, chapterId, characterId, clearChapter, clearCharacter }, ct);
[McpServerTool(Name = "resolve_open_question")]
[Description("Settle a question with what the writer decided. Set appendToNotes to also write "
+ "the resolution into the notes of the chapter and character it hangs off.")]
public static Task<CallToolResult> ResolveOpenQuestion(
NovelApiClient api,
[Description("The question's id.")] Guid questionId,
[Description("What was decided.")] string resolution,
CancellationToken ct,
[Description("Also append the resolution to the associated notes.")] bool appendToNotes = false) =>
api.PostAsync($"/api/questions/{questionId}/resolve", new { resolution, appendToNotes }, ct);
[McpServerTool(Name = "reopen_question")]
[Description("Put a resolved question back on the list. Anything already appended to notes stays.")]
public static Task<CallToolResult> ReopenQuestion(
NovelApiClient api,
[Description("The question's id.")] Guid questionId,
CancellationToken ct) =>
api.PostAsync($"/api/questions/{questionId}/reopen", new { }, ct);
[McpServerTool(Name = "delete_open_question")]
[Description("Delete a question outright. Resolving is usually better — it keeps the decision.")]
public static Task<CallToolResult> DeleteOpenQuestion(
NovelApiClient api,
[Description("The question's id.")] Guid questionId,
CancellationToken ct) =>
api.DeleteAsync($"/api/questions/{questionId}", ct);
}
-56
View File
@@ -1,56 +0,0 @@
using System.ComponentModel;
using ModelContextProtocol.Protocol;
using ModelContextProtocol.Server;
namespace Novelly.Mcp.Tools;
[McpServerToolType]
public static class TagTools
{
[McpServerTool(Name = "list_tags")]
[Description("List a novel's tags with how many characters, chapters and beats carry each. "
+ "Read this before inventing a new tag so you reuse the writer's vocabulary.")]
public static Task<CallToolResult> ListTags(
NovelApiClient api,
[Description("The novel's id.")] Guid novelId,
CancellationToken ct) =>
api.GetAsync($"/api/novels/{novelId}/tags", ct);
[McpServerTool(Name = "get_tag_references")]
[Description("Cross-reference a tag: every character, chapter and beat carrying it. Use this "
+ "to trace a motif, a thread, or a piece of setup through the book.")]
public static Task<CallToolResult> GetTagReferences(
NovelApiClient api,
[Description("The tag's id.")] Guid tagId,
CancellationToken ct) =>
api.GetAsync($"/api/tags/{tagId}/references", ct);
[McpServerTool(Name = "create_tag")]
[Description("Create a tag explicitly. Applying an unknown tag by name to a character, "
+ "chapter or beat also creates it, so this is only needed to set a colour up front.")]
public static Task<CallToolResult> CreateTag(
NovelApiClient api,
[Description("The novel's id.")] Guid novelId,
[Description("The tag's name. Unique within the novel, matched case-insensitively.")] string name,
CancellationToken ct,
[Description("Optional hex colour for the UI, e.g. \"#9a4a2f\".")] string? color = null) =>
api.PostAsync($"/api/novels/{novelId}/tags", new { name, color }, ct);
[McpServerTool(Name = "update_tag")]
[Description("Rename or recolour a tag. Renaming updates it everywhere it is applied.")]
public static Task<CallToolResult> UpdateTag(
NovelApiClient api,
[Description("The tag's id.")] Guid tagId,
CancellationToken ct,
[Description("New name.")] string? name = null,
[Description("Hex colour, e.g. \"#9a4a2f\".")] string? color = null) =>
api.PatchAsync($"/api/tags/{tagId}", new { name, color }, ct);
[McpServerTool(Name = "delete_tag")]
[Description("Delete a tag. Whatever carried it is left alone — only the label goes.")]
public static Task<CallToolResult> DeleteTag(
NovelApiClient api,
[Description("The tag's id.")] Guid tagId,
CancellationToken ct) =>
api.DeleteAsync($"/api/tags/{tagId}", ct);
}
@@ -21,17 +21,12 @@ public static class Extensions
public static TBuilder AddServiceDefaults<TBuilder>(this TBuilder builder) where TBuilder : IHostApplicationBuilder public static TBuilder AddServiceDefaults<TBuilder>(this TBuilder builder) where TBuilder : IHostApplicationBuilder
{ {
builder.ConfigureOpenTelemetry(); builder.ConfigureOpenTelemetry();
builder.AddDefaultHealthChecks(); builder.AddDefaultHealthChecks();
builder.Services.AddServiceDiscovery(); builder.Services.AddServiceDiscovery();
builder.Services.ConfigureHttpClientDefaults(http => builder.Services.ConfigureHttpClientDefaults(http =>
{ {
// Turn on resilience by default
http.AddStandardResilienceHandler(); http.AddStandardResilienceHandler();
// Turn on service discovery by default
http.AddServiceDiscovery(); http.AddServiceDiscovery();
}); });

Some files were not shown because too many files have changed in this diff Show More