rewind-mcp-server 0.9.0 → 0.11.0

package/dist/tools/schemas/reading.js

@@ -0,0 +1,151 @@
+/**
+ * Output schemas for the reading-domain tools (issue #105).
+ *
+ * These schemas are the source of truth for the reading tools' return
+ * shapes: `reading.ts` derives its `Article` / `Highlight` / `Related`
+ * payload types from them via `z.infer`, so the declared schema and the
+ * TypeScript type cannot drift.
+ *
+ * Every object schema uses `.passthrough()` so the JSON Schema advertised
+ * to clients stays `additionalProperties`-open -- a field the Rewind API
+ * adds later does not break client-side validation. See schemas/shared.ts.
+ */
+import { z } from 'zod';
+import { imageSchema, highlightsPaginationSchema } from './shared.js';
+// --- Element schemas ------------------------------------------------------
+/** A saved article, as listed by get_recent_reads. */
+export const articleSchema = z
+    .object({
+    id: z.number(),
+    title: z.string(),
+    author: z.string().nullable(),
+    url: z.string().nullable(),
+    // The list endpoint omits these keys entirely on some rows, so they
+    // are optional (nullish), not merely nullable.
+    instapaper_url: z.string().nullish(),
+    instapaper_app_url: z.string().nullish(),
+    domain: z.string().nullable(),
+    description: z.string().nullish(),
+    estimated_read_min: z.number().nullable(),
+    status: z.string(),
+    progress: z.number(),
+    image: imageSchema(),
+    saved_at: z.string(),
+})
+    .passthrough();
+/** The parent-article reference embedded in a highlight. */
+const highlightArticleSchema = z
+    .object({
+    id: z.number().optional(),
+    title: z.string(),
+    author: z.string().nullable(),
+    domain: z.string().nullable(),
+    url: z.string().nullish(),
+    instapaper_url: z.string().nullish(),
+    instapaper_app_url: z.string().nullish(),
+})
+    .passthrough();
+/** A single highlight, as listed by get_reading_highlights / get_random_highlight. */
+export const highlightSchema = z
+    .object({
+    text: z.string(),
+    note: z.string().nullable(),
+    created_at: z.string(),
+    article: highlightArticleSchema,
+})
+    .passthrough();
+/** A related-article result from find_similar_articles. */
+export const relatedArticleSchema = z
+    .object({
+    id: z.number(),
+    title: z.string(),
+    author: z.string().nullable(),
+    url: z.string().nullable(),
+    instapaper_url: z.string().nullable(),
+    instapaper_app_url: z.string().nullable(),
+    domain: z.string().nullable(),
+    description: z.string().nullable(),
+    score: z.number(),
+})
+    .passthrough();
+// --- Tool output schemas --------------------------------------------------
+/**
+ * outputSchema for get_recent_reads. The empty-state branch returns
+ * `{ items: [] }`, which satisfies the same schema -- no union needed.
+ */
+export const recentReadsOutputSchema = z
+    .object({ items: z.array(articleSchema) })
+    .passthrough();
+/**
+ * outputSchema for get_reading_highlights. Both the populated and the
+ * empty-state branch return `{ items, pagination }` -- the empty branch
+ * just has `items: []`, so one schema covers both.
+ */
+export const readingHighlightsOutputSchema = z
+    .object({
+    items: z.array(highlightSchema),
+    pagination: highlightsPaginationSchema(),
+})
+    .passthrough();
+/**
+ * outputSchema for get_random_highlight. The tool returns the raw
+ * highlight object unchanged as structuredContent.
+ */
+export const randomHighlightOutputSchema = highlightSchema;
+/** outputSchema for get_reading_stats (flat stats object). */
+export const readingStatsOutputSchema = z
+    .object({
+    total_articles: z.number(),
+    finished_count: z.number(),
+    currently_reading_count: z.number(),
+    total_highlights: z.number(),
+    total_word_count: z.number(),
+    avg_estimated_read_min: z.number(),
+})
+    .passthrough();
+/**
+ * outputSchema for find_similar_articles. The empty-state branch returns
+ * `{ items: [] }`, which satisfies the same schema -- no union needed.
+ */
+export const similarArticlesOutputSchema = z
+    .object({ items: z.array(relatedArticleSchema) })
+    .passthrough();
+/**
+ * outputSchema for get_article. The tool builds a transformed, card-shaped
+ * payload -- this schema describes that shape, not the raw
+ * `/reading/articles/:id` API response. The full body is omitted from
+ * structuredContent (it lives in the text content block); highlights are
+ * capped at 5, with the true total surfaced via `highlight_count`.
+ */
+export const articleDetailOutputSchema = z
+    .object({
+    article: z
+        .object({
+        id: z.number(),
+        title: z.string(),
+        author: z.string().nullable(),
+        url: z.string().nullable(),
+        instapaper_url: z.string().nullable(),
+        instapaper_app_url: z.string().nullable(),
+        domain: z.string().nullable(),
+        description: z.string().nullable(),
+        word_count: z.number().nullable(),
+        estimated_read_min: z.number().nullable(),
+        status: z.string(),
+        progress: z.number(),
+        saved_at: z.string(),
+        image: imageSchema(),
+    })
+        .passthrough(),
+    highlights: z.array(z
+        .object({
+        id: z.number(),
+        text: z.string(),
+        note: z.string().nullable(),
+        created_at: z.string(),
+    })
+        .passthrough()),
+    highlight_count: z.number(),
+})
+    .passthrough();
+//# sourceMappingURL=reading.js.map

package/dist/tools/schemas/reading.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reading.js","sourceRoot":"","sources":["../../../src/tools/schemas/reading.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AACH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,WAAW,EAAE,0BAA0B,EAAE,MAAM,aAAa,CAAC;AAEtE,6EAA6E;AAE7E,sDAAsD;AACtD,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC;KAC3B,MAAM,CAAC;IACN,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC1B,oEAAoE;IACpE,+CAA+C;IAC/C,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE;IACpC,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE;IACxC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE;IACjC,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,KAAK,EAAE,WAAW,EAAE;IACpB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;CACrB,CAAC;KACD,WAAW,EAAE,CAAC;AAEjB,4DAA4D;AAC5D,MAAM,sBAAsB,GAAG,CAAC;KAC7B,MAAM,CAAC;IACN,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE;IACzB,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE;IACpC,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE;CACzC,CAAC;KACD,WAAW,EAAE,CAAC;AAEjB,sFAAsF;AACtF,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC;KAC7B,MAAM,CAAC;IACN,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,OAAO,EAAE,sBAAsB;CAChC,CAAC;KACD,WAAW,EAAE,CAAC;AAEjB,2DAA2D;AAC3D,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC;KAClC,MAAM,CAAC;IACN,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC1B,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;CAClB,CAAC;KACD,WAAW,EAAE,CAAC;AAEjB,6EAA6E;AAE7E;;;GAGG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC;KACrC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE,CAAC;KACzC,WAAW,EAAE,CAAC;AAEjB;;;;GAIG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC;KAC3C,MAAM,CAAC;IACN,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC;IAC/B,UAAU,EAAE,0BAA0B,EAAE;CACzC,CAAC;KACD,WAAW,EAAE,CAAC;AAEjB;;;GAGG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,eAAe,CAAC;AAE3D,8DAA8D;AAC9D,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC;KACtC,MAAM,CAAC;IACN,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE;IAC1B,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE;IAC1B,uBAAuB,EAAE,CAAC,CAAC,MAAM,EAAE;IACnC,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE;IAC5B,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE;IAC5B,sBAAsB,EAAE,CAAC,CAAC,MAAM,EAAE;CACnC,CAAC;KACD,WAAW,EAAE,CAAC;AAEjB;;;GAGG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC;KACzC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC,EAAE,CAAC;KAChD,WAAW,EAAE,CAAC;AAEjB;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC;KACvC,MAAM,CAAC;IACN,OAAO,EAAE,CAAC;SACP,MAAM,CAAC;QACN,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;QACd,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;QACjB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC7B,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC1B,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QACrC,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QACzC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC7B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAClC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QACjC,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QACzC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;QAClB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;QACpB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;QACpB,KAAK,EAAE,WAAW,EAAE;KACrB,CAAC;SACD,WAAW,EAAE;IAChB,UAAU,EAAE,CAAC,CAAC,KAAK,CACjB,CAAC;SACE,MAAM,CAAC;QACN,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;QACd,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;QAChB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC3B,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;KACvB,CAAC;SACD,WAAW,EAAE,CACjB;IACD,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE;CAC5B,CAAC;KACD,WAAW,EAAE,CAAC"}