@cyanheads/hn-mcp-server 0.5.21 → 0.6.0

package/dist/mcp-server/tools/definitions/search-content.tool.d.ts

@@ -4,6 +4,67 @@
  */
 import { z } from '@cyanheads/mcp-ts-core';
 import { JsonRpcErrorCode } from '@cyanheads/mcp-ts-core/errors';
+/**
+ * Drop the scheme and `www.` from a query that is a URL alone. Algolia requires
+ * every token, so `https` and `www` would otherwise have to appear in the
+ * submitted URL, and the same page submitted under the other scheme or without
+ * `www.` would drop out. A query with whitespace is searched as typed, and so
+ * is one the prefix would leave empty.
+ */
+export declare function stripUrlPrefix(query: string): {
+    query: string;
+    droppedPrefix?: string;
+};
+/** What the search notice is composed from: the inputs as searched, and the page Algolia returned. */
+export interface SearchNoticeFacts {
+    author?: string | undefined;
+    /** How a full page over the response budget was fitted to it; absent for a page that fit. */
+    budget?: SearchBudget | undefined;
+    count: number;
+    dateRange?: {
+        start?: string | undefined;
+        end?: string | undefined;
+    } | undefined;
+    /** The URL prefix dropped from the caller's query before searching. */
+    droppedPrefix?: string | undefined;
+    minPoints?: number | undefined;
+    /**
+     * The caller's count and page when count was above the per-call cap. The
+     * search then ran at `count` (the cap) and `page` (the page at the cap where
+     * the requested page starts), which the other facts describe.
+     */
+    overCap?: {
+        count: number;
+        page: number;
+    } | undefined;
+    page: number;
+    /** The query sent to Algolia; absent for a filter-only search. */
+    query?: string | undefined;
+    /** Hits on this page. */
+    shown: number;
+    storyId?: number | undefined;
+    tags?: string | undefined;
+    totalHits: number;
+    /** False when totalHits is an estimate; undefined when Algolia does not say. */
+    totalHitsExact?: boolean | undefined;
+    totalPages: number;
+}
+/** The two steps that fit a full page over the response budget to it. */
+interface SearchBudget {
+    /** Ids of the hits step 2 cut the text of, in page order; empty when step 1 sufficed. */
+    cutIds: readonly number[];
+    /** Step 1 dropped highlights.text from every hit. False when no hit carried one. */
+    highlightsTextOmitted: boolean;
+}
+/**
+ * Compose the one `notice` string every search writes. `notice` is last-wins,
+ * so each source goes through here: the page-state sentence first, then the
+ * cause sentences in input order — query, tags, author, storyId, count — then
+ * the budget sentence for a page fitted to the response budget. None replaces
+ * another. Undefined when nothing applies — the last page of an uncapped,
+ * non-empty search that fit.
+ */
+export declare function composeSearchNotice(facts: SearchNoticeFacts): string | undefined;
 export declare const searchHn: import("@cyanheads/mcp-ts-core").ToolDefinition<z.ZodObject<{
     query: z.ZodOptional<z.ZodString>;
     tags: z.ZodOptional<z.ZodEnum<{
@@ -35,6 +96,13 @@ export declare const searchHn: import("@cyanheads/mcp-ts-core").ToolDefinition<z
 }, z.core.$strip>, z.ZodObject<{
     hits: z.ZodArray<z.ZodObject<{
         id: z.ZodNumber;
+        type: z.ZodOptional<z.ZodEnum<{
+            comment: "comment";
+            job: "job";
+            poll: "poll";
+            pollopt: "pollopt";
+            story: "story";
+        }>>;
         title: z.ZodOptional<z.ZodString>;
         url: z.ZodOptional<z.ZodString>;
         domain: z.ZodOptional<z.ZodString>;
@@ -45,6 +113,7 @@ export declare const searchHn: import("@cyanheads/mcp-ts-core").ToolDefinition<z
         storyTitle: z.ZodOptional<z.ZodString>;
         storyId: z.ZodOptional<z.ZodNumber>;
         text: z.ZodOptional<z.ZodString>;
+        textTruncated: z.ZodOptional<z.ZodBoolean>;
         highlights: z.ZodOptional<z.ZodObject<{
             title: z.ZodOptional<z.ZodString>;
             text: z.ZodOptional<z.ZodString>;
@@ -70,6 +139,12 @@ export declare const searchHn: import("@cyanheads/mcp-ts-core").ToolDefinition<z
     readonly when: "minPoints was combined with tags \"comment\" or \"job\", record types Algolia stores without points.";
     readonly recovery: "Drop minPoints to search comments or jobs, or search a scored type (story, poll, ask_hn, show_hn, front_page) to filter by points.";
     readonly severity: "notice";
+}, {
+    readonly reason: "count_page_unaligned";
+    readonly code: JsonRpcErrorCode.InvalidParams;
+    readonly when: "count was above the per-call cap of 50 with a page whose first hit (page × count) begins no page of 50 hits, so the requested page cannot be served from its start at the cap.";
+    readonly recovery: "Pass a count of 50 or less with page counted in that count; the error names a count and page that start at the same hit and, when that count is under 25, the page of 50 that holds the hit.";
+    readonly severity: "notice";
 }, {
     readonly reason: "upstream_rejected";
     readonly code: JsonRpcErrorCode.InvalidParams;
@@ -105,12 +180,43 @@ export declare const searchHn: import("@cyanheads/mcp-ts-core").ToolDefinition<z
     readonly retryable: true;
     readonly thrownBy: "service";
 }], {
+    readonly criteria: z.ZodObject<{
+        tags: z.ZodOptional<z.ZodEnum<{
+            ask_hn: "ask_hn";
+            comment: "comment";
+            front_page: "front_page";
+            job: "job";
+            poll: "poll";
+            show_hn: "show_hn";
+            story: "story";
+        }>>;
+        author: z.ZodOptional<z.ZodString>;
+        storyId: z.ZodOptional<z.ZodNumber>;
+        minPoints: z.ZodOptional<z.ZodNumber>;
+        dateRange: z.ZodOptional<z.ZodObject<{
+            start: z.ZodOptional<z.ZodString>;
+            end: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+        sort: z.ZodEnum<{
+            date: "date";
+            relevance: "relevance";
+        }>;
+        count: z.ZodNumber;
+        view: z.ZodEnum<{
+            compact: "compact";
+            full: "full";
+        }>;
+    }, z.core.$strip>;
     readonly totalHits: z.ZodNumber;
+    readonly totalHitsExact: z.ZodOptional<z.ZodBoolean>;
     readonly page: z.ZodNumber;
     readonly totalPages: z.ZodNumber;
+    readonly reachableHits: z.ZodOptional<z.ZodNumber>;
     readonly truncated: z.ZodOptional<z.ZodBoolean>;
     readonly shown: z.ZodOptional<z.ZodNumber>;
     readonly cap: z.ZodOptional<z.ZodNumber>;
+    readonly highlightsTextOmitted: z.ZodOptional<z.ZodBoolean>;
     readonly notice: z.ZodOptional<z.ZodString>;
 }>;
+export {};
 //# sourceMappingURL=search-content.tool.d.ts.map

package/dist/mcp-server/tools/definitions/search-content.tool.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"search-content.tool.d.ts","sourceRoot":"","sources":["../../../../src/mcp-server/tools/definitions/search-content.tool.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAQ,CAAC,EAAE,MAAM,wBAAwB,CAAC;AACjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AA2KjE,eAAO,MAAM,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAqYnB,CAAC"}
+{"version":3,"file":"search-content.tool.d.ts","sourceRoot":"","sources":["../../../../src/mcp-server/tools/definitions/search-content.tool.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAQ,CAAC,EAAE,MAAM,wBAAwB,CAAC;AACjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AA+HjE;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,aAAa,CAAC,EAAE,MAAM,CAAA;CAAE,CAKvF;AA0ED,sGAAsG;AACtG,MAAM,WAAW,iBAAiB;IAChC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,6FAA6F;IAC7F,MAAM,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;IAClC,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE,GAAG,SAAS,CAAC;IACjF,uEAAuE;IACvE,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B;;;;OAIG;IACH,OAAO,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,SAAS,CAAC;IACtD,IAAI,EAAE,MAAM,CAAC;IACb,kEAAkE;IAClE,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,yBAAyB;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,SAAS,EAAE,MAAM,CAAC;IAClB,gFAAgF;IAChF,cAAc,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACrC,UAAU,EAAE,MAAM,CAAC;CACpB;AA8FD,yEAAyE;AACzE,UAAU,YAAY;IACpB,yFAAyF;IACzF,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;IAC1B,oFAAoF;IACpF,qBAAqB,EAAE,OAAO,CAAC;CAChC;AAYD;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,iBAAiB,GAAG,MAAM,GAAG,SAAS,CAOhF;AAmQD,eAAO,MAAM,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA+XnB,CAAC"}