From 185199a162ef7e2eb720ca0d46ef035c8b3cde5b Mon Sep 17 00:00:00 2001 From: Ryan Wang Date: Wed, 11 Nov 2026 23:23:31 +0800 Subject: [PATCH] Add excerpt fields to single page tools --- .../halo/mcpserver/tools/ContentPayloads.java | 10 +++ .../halo/mcpserver/tools/SinglePageTools.java | 32 ++++++-- .../mcpserver/tools/SinglePageToolsTest.java | 73 +++++++++++++++++++ 3 files changed, 110 insertions(+), 5 deletions(-) diff --git a/src/main/java/run/halo/mcpserver/tools/ContentPayloads.java b/src/main/java/run/halo/mcpserver/tools/ContentPayloads.java index 06ef88f..6fb6517 100644 --- a/src/main/java/run/halo/mcpserver/tools/ContentPayloads.java +++ b/src/main/java/run/halo/mcpserver/tools/ContentPayloads.java @@ -74,6 +74,8 @@ static Map singlePageSchema() { "title", halo(SinglePage.SinglePageSpec.class, "title"), "slug", halo(SinglePage.SinglePageSpec.class, "slug"), "excerpt", halo(Post.PostStatus.class, "excerpt"), + "excerptRaw", halo(Post.Excerpt.class, "raw"), + "autoGenerateExcerpt", halo(Post.Excerpt.class, "autoGenerate"), "published", ToolSupport.described( ToolSupport.booleanSchema(), "Whether the single page is currently published."), @@ -293,6 +295,14 @@ static Map singlePage(SinglePage page) { "title", spec == null ? null : spec.getTitle(), "slug", spec == null ? null : spec.getSlug(), "excerpt", status == null ? null : status.getExcerpt(), + "excerptRaw", + spec == null || spec.getExcerpt() == null + ? null + : spec.getExcerpt().getRaw(), + "autoGenerateExcerpt", + spec == null + || spec.getExcerpt() == null + || Boolean.TRUE.equals(spec.getExcerpt().getAutoGenerate()), "published", published(page.getMetadata(), SinglePage.PUBLISHED_LABEL), "publishRequested", spec != null && Boolean.TRUE.equals(spec.getPublish()), "recycled", spec != null && Boolean.TRUE.equals(spec.getDeleted()), diff --git a/src/main/java/run/halo/mcpserver/tools/SinglePageTools.java b/src/main/java/run/halo/mcpserver/tools/SinglePageTools.java index 6ec984d..582b81a 100644 --- a/src/main/java/run/halo/mcpserver/tools/SinglePageTools.java +++ b/src/main/java/run/halo/mcpserver/tools/SinglePageTools.java @@ -287,7 +287,9 @@ private BuiltInTool createTool() { booleanSchema(false), "Whether to publish the initial snapshot immediately."), "visible", enumSchema(Post.VisibleEnum.class, Post.VisibleEnum.PUBLIC.name()), - "allowComment", booleanSchema(true)), + "allowComment", booleanSchema(true), + "excerpt", nullableStringSchema(), + "autoGenerateExcerpt", booleanSchema()), List.of("name", "title", "raw")), ContentPayloads.singlePageSchema(), CREATE, @@ -320,7 +322,9 @@ private BuiltInTool updateTool() { + " updating existing content, reuse the rawType returned by" + " the read tool."), "visible", enumSchema(Post.VisibleEnum.class), - "allowComment", booleanSchema()), + "allowComment", booleanSchema(), + "excerpt", nullableStringSchema(), + "autoGenerateExcerpt", booleanSchema()), List.of("name")), ContentPayloads.singlePageSchema(), UPDATE, @@ -400,9 +404,7 @@ private static SinglePage.SinglePageSpec spec( spec.setAllowComment(optionalBoolean(arguments, "allowComment", true)); spec.setPinned(false); spec.setPriority(0); - var excerpt = new Post.Excerpt(); - excerpt.setAutoGenerate(true); - spec.setExcerpt(excerpt); + spec.setExcerpt(excerpt(arguments, null)); return spec; } @@ -420,6 +422,26 @@ private static void applyMetadata(SinglePage page, Map arguments if (arguments.containsKey("allowComment")) { spec.setAllowComment(optionalBoolean(arguments, "allowComment", true)); } + if (arguments.containsKey("excerpt") || arguments.containsKey("autoGenerateExcerpt")) { + spec.setExcerpt(excerpt(arguments, spec.getExcerpt())); + } + } + + private static Post.Excerpt excerpt(Map arguments, Post.Excerpt current) { + var excerpt = current == null ? new Post.Excerpt() : current; + if (arguments.containsKey("excerpt")) { + excerpt.setRaw(nullableString(arguments, "excerpt")); + } + final boolean autoGenerate; + if (arguments.containsKey("autoGenerateExcerpt")) { + autoGenerate = optionalBoolean(arguments, "autoGenerateExcerpt", true); + } else if (arguments.containsKey("excerpt")) { + autoGenerate = false; + } else { + autoGenerate = current == null || Boolean.TRUE.equals(current.getAutoGenerate()); + } + excerpt.setAutoGenerate(autoGenerate); + return excerpt; } private static ContentSnapshots.ContentInput content(Map arguments) { diff --git a/src/test/java/run/halo/mcpserver/tools/SinglePageToolsTest.java b/src/test/java/run/halo/mcpserver/tools/SinglePageToolsTest.java index cc890d6..075f8af 100644 --- a/src/test/java/run/halo/mcpserver/tools/SinglePageToolsTest.java +++ b/src/test/java/run/halo/mcpserver/tools/SinglePageToolsTest.java @@ -17,6 +17,7 @@ import org.springframework.dao.OptimisticLockingFailureException; import reactor.core.publisher.Mono; import reactor.test.StepVerifier; +import run.halo.app.core.extension.content.Post; import run.halo.app.core.extension.content.SinglePage; import run.halo.app.core.extension.content.Snapshot; import run.halo.app.extension.ReactiveExtensionClient; @@ -76,6 +77,78 @@ void updatesPageMetadataWithoutCreatingSnapshot() { verify(client, times(0)).create(any(run.halo.app.core.extension.content.Snapshot.class)); } + @Test + @SuppressWarnings("unchecked") + void createsPageWithManualExcerpt() { + var storedPage = new AtomicReference(); + when(authorization.username()).thenReturn(Mono.just("admin")); + when(client.create(any(SinglePage.class))).thenAnswer(invocation -> { + var page = invocation.getArgument(0); + storedPage.set(page); + return Mono.just(page); + }); + when(client.create(any(Snapshot.class))).thenAnswer(invocation -> Mono.just(invocation.getArgument(0))); + when(client.fetch(SinglePage.class, "about")).thenAnswer(invocation -> Mono.just(storedPage.get())); + when(client.update(any(SinglePage.class))).thenAnswer(invocation -> Mono.just(invocation.getArgument(0))); + var tools = new SinglePageTools(client, new ContentSnapshots(client), authorization); + + StepVerifier.create(tools.create(Map.of( + "name", "about", + "title", "About", + "raw", "Body", + "excerpt", "Manual summary"))) + .assertNext(payload -> { + assertThat(storedPage.get().getSpec().getExcerpt().getRaw()).isEqualTo("Manual summary"); + assertThat(storedPage.get().getSpec().getExcerpt().getAutoGenerate()) + .isFalse(); + var item = (Map) payload.data(); + assertThat(item.get("excerptRaw")).isEqualTo("Manual summary"); + assertThat(item.get("autoGenerateExcerpt")).isEqualTo(false); + }) + .verifyComplete(); + } + + @Test + @SuppressWarnings("unchecked") + void updatesPageExcerptWithoutCreatingSnapshot() { + var page = page(3L); + when(client.fetch(SinglePage.class, "about")).thenReturn(Mono.just(page)); + when(client.update(page)).thenReturn(Mono.just(page)); + var tools = new SinglePageTools(client, new ContentSnapshots(client), authorization); + + StepVerifier.create(tools.update(Map.of("name", "about", "excerpt", "Short summary"))) + .assertNext(payload -> { + assertThat(page.getSpec().getExcerpt().getRaw()).isEqualTo("Short summary"); + assertThat(page.getSpec().getExcerpt().getAutoGenerate()).isFalse(); + var item = (Map) payload.data(); + assertThat(item.get("excerptRaw")).isEqualTo("Short summary"); + assertThat(item.get("autoGenerateExcerpt")).isEqualTo(false); + }) + .verifyComplete(); + + verify(client, times(1)).update(any(SinglePage.class)); + verify(client, never()).create(any(Snapshot.class)); + } + + @Test + void enablesAutoGeneratedExcerptWithoutClearingTheManualRaw() { + var page = page(3L); + var excerpt = new Post.Excerpt(); + excerpt.setRaw("Kept summary"); + excerpt.setAutoGenerate(false); + page.getSpec().setExcerpt(excerpt); + when(client.fetch(SinglePage.class, "about")).thenReturn(Mono.just(page)); + when(client.update(page)).thenReturn(Mono.just(page)); + var tools = new SinglePageTools(client, new ContentSnapshots(client), authorization); + + StepVerifier.create(tools.update(Map.of("name", "about", "autoGenerateExcerpt", true))) + .assertNext(payload -> { + assertThat(page.getSpec().getExcerpt().getRaw()).isEqualTo("Kept summary"); + assertThat(page.getSpec().getExcerpt().getAutoGenerate()).isTrue(); + }) + .verifyComplete(); + } + @Test void removesANewSnapshotWhenTheHeadChangedConcurrently() { var original = page(3L);