@cyanheads/hn-mcp-server 0.5.21 → 0.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +26 -10
- package/CLAUDE.md +26 -10
- package/Dockerfile +10 -4
- package/README.md +31 -19
- package/changelog/0.5.x/0.5.22.md +45 -0
- package/changelog/0.6.x/0.6.0.md +38 -0
- package/dist/index.js +1 -0
- package/dist/index.js.map +1 -1
- package/dist/mcp-server/tools/definitions/get-stories.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/definitions/get-stories.tool.js +31 -17
- package/dist/mcp-server/tools/definitions/get-stories.tool.js.map +1 -1
- package/dist/mcp-server/tools/definitions/get-thread.tool.d.ts +4 -2
- package/dist/mcp-server/tools/definitions/get-thread.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/definitions/get-thread.tool.js +427 -220
- package/dist/mcp-server/tools/definitions/get-thread.tool.js.map +1 -1
- package/dist/mcp-server/tools/definitions/get-user.tool.d.ts +1 -0
- package/dist/mcp-server/tools/definitions/get-user.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/definitions/get-user.tool.js +176 -106
- package/dist/mcp-server/tools/definitions/get-user.tool.js.map +1 -1
- package/dist/mcp-server/tools/definitions/search-content.tool.d.ts +106 -0
- package/dist/mcp-server/tools/definitions/search-content.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/definitions/search-content.tool.js +532 -194
- package/dist/mcp-server/tools/definitions/search-content.tool.js.map +1 -1
- package/dist/mcp-server/tools/response-budget.d.ts +111 -0
- package/dist/mcp-server/tools/response-budget.d.ts.map +1 -0
- package/dist/mcp-server/tools/response-budget.js +204 -0
- package/dist/mcp-server/tools/response-budget.js.map +1 -0
- package/dist/mcp-server/tools/served-at-cap.d.ts +14 -0
- package/dist/mcp-server/tools/served-at-cap.d.ts.map +1 -0
- package/dist/mcp-server/tools/served-at-cap.js +16 -0
- package/dist/mcp-server/tools/served-at-cap.js.map +1 -0
- package/dist/mcp-server/tools/thread-cursor.d.ts +68 -0
- package/dist/mcp-server/tools/thread-cursor.d.ts.map +1 -0
- package/dist/mcp-server/tools/thread-cursor.js +200 -0
- package/dist/mcp-server/tools/thread-cursor.js.map +1 -0
- package/dist/services/hn/hn-service.d.ts +73 -12
- package/dist/services/hn/hn-service.d.ts.map +1 -1
- package/dist/services/hn/hn-service.js +127 -38
- package/dist/services/hn/hn-service.js.map +1 -1
- package/dist/services/hn/types.d.ts +9 -0
- package/dist/services/hn/types.d.ts.map +1 -1
- package/package.json +13 -12
- package/server.json +3 -3
- package/skills/hn-guide/SKILL.md +39 -0
package/AGENTS.md
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
# Developer Protocol
|
|
2
2
|
|
|
3
3
|
**Server:** hn-mcp-server
|
|
4
|
-
**Version:** 0.
|
|
5
|
-
**Framework:** [@cyanheads/mcp-ts-core](https://www.npmjs.com/package/@cyanheads/mcp-ts-core) `^0.13.
|
|
4
|
+
**Version:** 0.6.0
|
|
5
|
+
**Framework:** [@cyanheads/mcp-ts-core](https://www.npmjs.com/package/@cyanheads/mcp-ts-core) `^0.13.18`
|
|
6
6
|
**Engines:** Bun ≥1.4.0, Node ≥24.0.0
|
|
7
|
-
**MCP SDK:** `@modelcontextprotocol/server` 2.
|
|
8
|
-
**Zod:** ^4.6.
|
|
7
|
+
**MCP SDK:** `@modelcontextprotocol/server` 2.4.0
|
|
8
|
+
**Zod:** ^4.6.7
|
|
9
9
|
|
|
10
10
|
> **Read the framework docs first:** `node_modules/@cyanheads/mcp-ts-core/CLAUDE.md` contains the full API reference — builders, Context, error codes, exports, patterns. This file covers server-specific conventions only.
|
|
11
11
|
|
|
@@ -48,7 +48,7 @@ Tailor suggestions to what's actually missing or stale — don't recite the full
|
|
|
48
48
|
|
|
49
49
|
```ts
|
|
50
50
|
import { tool, z } from '@cyanheads/mcp-ts-core';
|
|
51
|
-
import { getHnService, settlePage, normalizeUrl, stripHtml } from '@/services/hn/hn-service.js';
|
|
51
|
+
import { CALL_BUDGET_MS, getHnService, settlePage, normalizeUrl, stripHtml } from '@/services/hn/hn-service.js';
|
|
52
52
|
|
|
53
53
|
export const getStories = tool('hn_get_stories', {
|
|
54
54
|
description: 'Fetch stories from an HN feed (top, new, best, ask, show, jobs).',
|
|
@@ -70,10 +70,12 @@ export const getStories = tool('hn_get_stories', {
|
|
|
70
70
|
|
|
71
71
|
async handler(input, ctx) {
|
|
72
72
|
const hn = getHnService();
|
|
73
|
-
|
|
73
|
+
// One time budget for the feed and every item fetch after it.
|
|
74
|
+
const deadline = Date.now() + CALL_BUDGET_MS;
|
|
75
|
+
const feedIds = await hn.fetchFeed(input.feed, ctx, deadline);
|
|
74
76
|
const sliced = feedIds.slice(input.offset, input.offset + input.count);
|
|
75
77
|
// Live items plus the IDs whose fetch failed; throws when every item failed.
|
|
76
|
-
const { items, failedIds } = settlePage(await hn.fetchItems(sliced, ctx));
|
|
78
|
+
const { items, failedIds } = settlePage(await hn.fetchItems(sliced, ctx, deadline));
|
|
77
79
|
if (failedIds.length > 0) ctx.enrich({ failedIds });
|
|
78
80
|
ctx.log.info('Fetched stories', { feed: input.feed, count: items.length });
|
|
79
81
|
return { stories: items.map(/* ... */), feed: input.feed, total: feedIds.length };
|
|
@@ -218,6 +220,9 @@ src/
|
|
|
218
220
|
types.ts # HN domain types
|
|
219
221
|
mcp-server/
|
|
220
222
|
tools/markdown-escape.ts # format() boundary: escape titles, quote bodies
|
|
223
|
+
tools/response-budget.ts # 64,000-byte budget per response surface: measure both surfaces, largest shared body cut, code-point cut
|
|
224
|
+
tools/served-at-cap.ts # notice sentence for a size input served at its per-call cap
|
|
225
|
+
tools/thread-cursor.ts # hn_get_thread cursor codec: packed frontier, JSON format still decoded
|
|
221
226
|
tools/definitions/
|
|
222
227
|
get-stories.tool.ts # hn_get_stories — Fetch stories from an HN feed
|
|
223
228
|
get-thread.tool.ts # hn_get_thread — Get item + comment tree
|
|
@@ -240,9 +245,18 @@ src/
|
|
|
240
245
|
|
|
241
246
|
## Skills
|
|
242
247
|
|
|
243
|
-
|
|
248
|
+
Two skill trees live at the project root, written for different readers:
|
|
244
249
|
|
|
245
|
-
|
|
250
|
+
| Tree | For | Written by |
|
|
251
|
+
|:-----|:----|:-----------|
|
|
252
|
+
| `framework-skills/` | The agent developing this server — framework skills (`metadata.audience: external`) plus any development-time skills of the server's own | `init` and the `maintenance` sync (framework skills); you (your own) |
|
|
253
|
+
| `skills/` | The agents that install the server and call its tools — tool chains, identifier sources, gates | You, deliberately, with the `add-skill` skill. Absent by default; usually none is needed |
|
|
254
|
+
|
|
255
|
+
Development skills are modular instructions. Read them directly when a task matches — e.g., `framework-skills/add-tool/SKILL.md` when adding a tool. `bun run list-skills` prints the full registry. Their directory is deliberately not `skills/`: Claude Code and Codex auto-load a plugin's root `skills/`, so a server that ships `.claude-plugin/` or `.codex-plugin/` would hand them to every agent that installs it.
|
|
256
|
+
|
|
257
|
+
A published skill in root `skills/` reaches plugin installs and the `.mcpb` bundle as-is, ships in the npm package and the Docker image, and reaches MCP clients when the server opts in with `createApp({ skills: 'skills' })`. `lint:packaging` validates the tree.
|
|
258
|
+
|
|
259
|
+
**Agent skill directory:** Copy `framework-skills/` into the directory your agent discovers (Claude Code: `.claude/skills/`, others: equivalent). Skills then load as context without referencing `framework-skills/` paths. After framework updates, run the `maintenance` skill — Phase B re-syncs the agent directory.
|
|
246
260
|
|
|
247
261
|
Available skills:
|
|
248
262
|
|
|
@@ -254,6 +268,7 @@ Available skills:
|
|
|
254
268
|
| `add-app-tool` | Scaffold an MCP App tool + paired UI resource |
|
|
255
269
|
| `add-resource` | Scaffold a new resource definition |
|
|
256
270
|
| `add-prompt` | Scaffold a new prompt definition |
|
|
271
|
+
| `add-skill` | Author a skill the server publishes in root `skills/` for the agents that use it — when one earns its place, structure, validation, delivery |
|
|
257
272
|
| `add-service` | Scaffold a new service integration |
|
|
258
273
|
| `add-test` | Scaffold test file for a tool, resource, or service |
|
|
259
274
|
| `field-test` | Exercise tools/resources/prompts with real inputs, verify behavior, report issues |
|
|
@@ -320,7 +335,7 @@ When you complete a skill's checklist, check the boxes and add a completion time
|
|
|
320
335
|
|
|
321
336
|
## Bundling
|
|
322
337
|
|
|
323
|
-
`bun run bundle` produces a `.mcpb` extension bundle for one-click install in Claude Desktop. The pack step is followed by `scripts/clean-mcpb.ts`, which prunes dev dependencies (`mcpb clean`) and strips
|
|
338
|
+
`bun run bundle` produces a `.mcpb` extension bundle for one-click install in Claude Desktop. `mcpb pack` reads `.mcpbignore`, not `.gitignore`, so every root path the bundle must not ship — source, tests, docs, caches, logs, agent docs, plugin manifests, gitignored and local-only files such as `claude-plans/` — needs a root-anchored line there (`/docs/`, never `docs/`, which also strips `node_modules/*/docs/`); `lint:packaging` names each missing or unanchored line. The pack step is followed by `scripts/clean-mcpb.ts`, which prunes dev dependencies (`mcpb clean`) and strips four classes of `node_modules/**` content that root-anchored `.mcpbignore` patterns cannot reach: dependency-shipped agent docs (`framework-skills/`, `skills/`, `.claude/`, `.agents/` at a package's root, and any `SKILL.md`); platform-specific native bindings; node-gyp build output beside a `binding.gyp`; and the framework's build-only files. The agent-doc selector is anchored at each package root in both `clean-mcpb.ts` and `lint-packaging.ts` — a local divergence from the synced scripts until cyanheads/mcp-ts-core#794 ships — because MCP SDK 2.4 ships runtime code at `@modelcontextprotocol/{server,core}/dist/ext/skills/`, and the upstream selector strips it and breaks the bundle's startup. Re-apply it after a script resync; `tests/scripts/bundle-agent-docs.test.ts` fails if it is lost. MCPB is stdio-only — HTTP deployments are unaffected.
|
|
324
339
|
|
|
325
340
|
**Adding an env var requires both files:** `server.json` (registry discovery, `environmentVariables[]`) and `manifest.json` (bundle install UX, `mcp_config.env` + `user_config`). `lint:packaging` (run by `devcheck`) verifies the env var names match, that every `user_config` option is wired into `mcp_config.env` as `"X": "${user_config.X}"` (the host substitutes nothing else — `"${X}"` reaches the server as that literal string), and that an optional string option carries `"default": ""`.
|
|
326
341
|
|
|
@@ -378,6 +393,7 @@ import { getHnService } from '@/services/hn/hn-service.js';
|
|
|
378
393
|
bun publish --access public
|
|
379
394
|
|
|
380
395
|
docker buildx build --platform linux/amd64,linux/arm64 \
|
|
396
|
+
--build-arg APP_VERSION=<version> \
|
|
381
397
|
-t ghcr.io/cyanheads/hn-mcp-server:<version> \
|
|
382
398
|
-t ghcr.io/cyanheads/hn-mcp-server:latest \
|
|
383
399
|
--push .
|
package/CLAUDE.md
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
# Developer Protocol
|
|
2
2
|
|
|
3
3
|
**Server:** hn-mcp-server
|
|
4
|
-
**Version:** 0.
|
|
5
|
-
**Framework:** [@cyanheads/mcp-ts-core](https://www.npmjs.com/package/@cyanheads/mcp-ts-core) `^0.13.
|
|
4
|
+
**Version:** 0.6.0
|
|
5
|
+
**Framework:** [@cyanheads/mcp-ts-core](https://www.npmjs.com/package/@cyanheads/mcp-ts-core) `^0.13.18`
|
|
6
6
|
**Engines:** Bun ≥1.4.0, Node ≥24.0.0
|
|
7
|
-
**MCP SDK:** `@modelcontextprotocol/server` 2.
|
|
8
|
-
**Zod:** ^4.6.
|
|
7
|
+
**MCP SDK:** `@modelcontextprotocol/server` 2.4.0
|
|
8
|
+
**Zod:** ^4.6.7
|
|
9
9
|
|
|
10
10
|
> **Read the framework docs first:** `node_modules/@cyanheads/mcp-ts-core/CLAUDE.md` contains the full API reference — builders, Context, error codes, exports, patterns. This file covers server-specific conventions only.
|
|
11
11
|
|
|
@@ -48,7 +48,7 @@ Tailor suggestions to what's actually missing or stale — don't recite the full
|
|
|
48
48
|
|
|
49
49
|
```ts
|
|
50
50
|
import { tool, z } from '@cyanheads/mcp-ts-core';
|
|
51
|
-
import { getHnService, settlePage, normalizeUrl, stripHtml } from '@/services/hn/hn-service.js';
|
|
51
|
+
import { CALL_BUDGET_MS, getHnService, settlePage, normalizeUrl, stripHtml } from '@/services/hn/hn-service.js';
|
|
52
52
|
|
|
53
53
|
export const getStories = tool('hn_get_stories', {
|
|
54
54
|
description: 'Fetch stories from an HN feed (top, new, best, ask, show, jobs).',
|
|
@@ -70,10 +70,12 @@ export const getStories = tool('hn_get_stories', {
|
|
|
70
70
|
|
|
71
71
|
async handler(input, ctx) {
|
|
72
72
|
const hn = getHnService();
|
|
73
|
-
|
|
73
|
+
// One time budget for the feed and every item fetch after it.
|
|
74
|
+
const deadline = Date.now() + CALL_BUDGET_MS;
|
|
75
|
+
const feedIds = await hn.fetchFeed(input.feed, ctx, deadline);
|
|
74
76
|
const sliced = feedIds.slice(input.offset, input.offset + input.count);
|
|
75
77
|
// Live items plus the IDs whose fetch failed; throws when every item failed.
|
|
76
|
-
const { items, failedIds } = settlePage(await hn.fetchItems(sliced, ctx));
|
|
78
|
+
const { items, failedIds } = settlePage(await hn.fetchItems(sliced, ctx, deadline));
|
|
77
79
|
if (failedIds.length > 0) ctx.enrich({ failedIds });
|
|
78
80
|
ctx.log.info('Fetched stories', { feed: input.feed, count: items.length });
|
|
79
81
|
return { stories: items.map(/* ... */), feed: input.feed, total: feedIds.length };
|
|
@@ -218,6 +220,9 @@ src/
|
|
|
218
220
|
types.ts # HN domain types
|
|
219
221
|
mcp-server/
|
|
220
222
|
tools/markdown-escape.ts # format() boundary: escape titles, quote bodies
|
|
223
|
+
tools/response-budget.ts # 64,000-byte budget per response surface: measure both surfaces, largest shared body cut, code-point cut
|
|
224
|
+
tools/served-at-cap.ts # notice sentence for a size input served at its per-call cap
|
|
225
|
+
tools/thread-cursor.ts # hn_get_thread cursor codec: packed frontier, JSON format still decoded
|
|
221
226
|
tools/definitions/
|
|
222
227
|
get-stories.tool.ts # hn_get_stories — Fetch stories from an HN feed
|
|
223
228
|
get-thread.tool.ts # hn_get_thread — Get item + comment tree
|
|
@@ -240,9 +245,18 @@ src/
|
|
|
240
245
|
|
|
241
246
|
## Skills
|
|
242
247
|
|
|
243
|
-
|
|
248
|
+
Two skill trees live at the project root, written for different readers:
|
|
244
249
|
|
|
245
|
-
|
|
250
|
+
| Tree | For | Written by |
|
|
251
|
+
|:-----|:----|:-----------|
|
|
252
|
+
| `framework-skills/` | The agent developing this server — framework skills (`metadata.audience: external`) plus any development-time skills of the server's own | `init` and the `maintenance` sync (framework skills); you (your own) |
|
|
253
|
+
| `skills/` | The agents that install the server and call its tools — tool chains, identifier sources, gates | You, deliberately, with the `add-skill` skill. Absent by default; usually none is needed |
|
|
254
|
+
|
|
255
|
+
Development skills are modular instructions. Read them directly when a task matches — e.g., `framework-skills/add-tool/SKILL.md` when adding a tool. `bun run list-skills` prints the full registry. Their directory is deliberately not `skills/`: Claude Code and Codex auto-load a plugin's root `skills/`, so a server that ships `.claude-plugin/` or `.codex-plugin/` would hand them to every agent that installs it.
|
|
256
|
+
|
|
257
|
+
A published skill in root `skills/` reaches plugin installs and the `.mcpb` bundle as-is, ships in the npm package and the Docker image, and reaches MCP clients when the server opts in with `createApp({ skills: 'skills' })`. `lint:packaging` validates the tree.
|
|
258
|
+
|
|
259
|
+
**Agent skill directory:** Copy `framework-skills/` into the directory your agent discovers (Claude Code: `.claude/skills/`, others: equivalent). Skills then load as context without referencing `framework-skills/` paths. After framework updates, run the `maintenance` skill — Phase B re-syncs the agent directory.
|
|
246
260
|
|
|
247
261
|
Available skills:
|
|
248
262
|
|
|
@@ -254,6 +268,7 @@ Available skills:
|
|
|
254
268
|
| `add-app-tool` | Scaffold an MCP App tool + paired UI resource |
|
|
255
269
|
| `add-resource` | Scaffold a new resource definition |
|
|
256
270
|
| `add-prompt` | Scaffold a new prompt definition |
|
|
271
|
+
| `add-skill` | Author a skill the server publishes in root `skills/` for the agents that use it — when one earns its place, structure, validation, delivery |
|
|
257
272
|
| `add-service` | Scaffold a new service integration |
|
|
258
273
|
| `add-test` | Scaffold test file for a tool, resource, or service |
|
|
259
274
|
| `field-test` | Exercise tools/resources/prompts with real inputs, verify behavior, report issues |
|
|
@@ -320,7 +335,7 @@ When you complete a skill's checklist, check the boxes and add a completion time
|
|
|
320
335
|
|
|
321
336
|
## Bundling
|
|
322
337
|
|
|
323
|
-
`bun run bundle` produces a `.mcpb` extension bundle for one-click install in Claude Desktop. The pack step is followed by `scripts/clean-mcpb.ts`, which prunes dev dependencies (`mcpb clean`) and strips
|
|
338
|
+
`bun run bundle` produces a `.mcpb` extension bundle for one-click install in Claude Desktop. `mcpb pack` reads `.mcpbignore`, not `.gitignore`, so every root path the bundle must not ship — source, tests, docs, caches, logs, agent docs, plugin manifests, gitignored and local-only files such as `claude-plans/` — needs a root-anchored line there (`/docs/`, never `docs/`, which also strips `node_modules/*/docs/`); `lint:packaging` names each missing or unanchored line. The pack step is followed by `scripts/clean-mcpb.ts`, which prunes dev dependencies (`mcpb clean`) and strips four classes of `node_modules/**` content that root-anchored `.mcpbignore` patterns cannot reach: dependency-shipped agent docs (`framework-skills/`, `skills/`, `.claude/`, `.agents/` at a package's root, and any `SKILL.md`); platform-specific native bindings; node-gyp build output beside a `binding.gyp`; and the framework's build-only files. The agent-doc selector is anchored at each package root in both `clean-mcpb.ts` and `lint-packaging.ts` — a local divergence from the synced scripts until cyanheads/mcp-ts-core#794 ships — because MCP SDK 2.4 ships runtime code at `@modelcontextprotocol/{server,core}/dist/ext/skills/`, and the upstream selector strips it and breaks the bundle's startup. Re-apply it after a script resync; `tests/scripts/bundle-agent-docs.test.ts` fails if it is lost. MCPB is stdio-only — HTTP deployments are unaffected.
|
|
324
339
|
|
|
325
340
|
**Adding an env var requires both files:** `server.json` (registry discovery, `environmentVariables[]`) and `manifest.json` (bundle install UX, `mcp_config.env` + `user_config`). `lint:packaging` (run by `devcheck`) verifies the env var names match, that every `user_config` option is wired into `mcp_config.env` as `"X": "${user_config.X}"` (the host substitutes nothing else — `"${X}"` reaches the server as that literal string), and that an optional string option carries `"default": ""`.
|
|
326
341
|
|
|
@@ -378,6 +393,7 @@ import { getHnService } from '@/services/hn/hn-service.js';
|
|
|
378
393
|
bun publish --access public
|
|
379
394
|
|
|
380
395
|
docker buildx build --platform linux/amd64,linux/arm64 \
|
|
396
|
+
--build-arg APP_VERSION=<version> \
|
|
381
397
|
-t ghcr.io/cyanheads/hn-mcp-server:<version> \
|
|
382
398
|
-t ghcr.io/cyanheads/hn-mcp-server:latest \
|
|
383
399
|
--push .
|
package/Dockerfile
CHANGED
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
# output. A stage that compiles a native addon needs the target-arch toolchain
|
|
15
15
|
# and cannot cross-compile this way — drop the flag there.
|
|
16
16
|
# ==============================================================================
|
|
17
|
-
FROM --platform=$BUILDPLATFORM oven/bun:1.4.
|
|
17
|
+
FROM --platform=$BUILDPLATFORM oven/bun:1.4.4 AS build
|
|
18
18
|
|
|
19
19
|
WORKDIR /usr/src/app
|
|
20
20
|
|
|
@@ -29,6 +29,11 @@ RUN --mount=type=cache,target=/root/.bun/install/cache \
|
|
|
29
29
|
# Copy the rest of the source code
|
|
30
30
|
COPY . .
|
|
31
31
|
|
|
32
|
+
# The skills a server publishes (`createApp({ skills: 'skills' })`) are read at
|
|
33
|
+
# runtime from the application root. Created when the project has none, so the
|
|
34
|
+
# production stage's copy below holds with or without one.
|
|
35
|
+
RUN mkdir -p skills
|
|
36
|
+
|
|
32
37
|
# Build the application
|
|
33
38
|
RUN bun run build
|
|
34
39
|
|
|
@@ -46,7 +51,7 @@ RUN bun run build
|
|
|
46
51
|
# A clean image rather than `FROM build`: the build stage's node_modules holds
|
|
47
52
|
# devDependencies.
|
|
48
53
|
# ==============================================================================
|
|
49
|
-
FROM --platform=$BUILDPLATFORM oven/bun:1.4.
|
|
54
|
+
FROM --platform=$BUILDPLATFORM oven/bun:1.4.4 AS deps
|
|
50
55
|
|
|
51
56
|
WORKDIR /usr/src/app
|
|
52
57
|
|
|
@@ -114,7 +119,7 @@ RUN rm -rf node_modules/@socketsecurity/bun-security-scanner
|
|
|
114
119
|
# dependencies and build artifacts. Its only Bun invocations are HEALTHCHECK
|
|
115
120
|
# and CMD, which run on the real target at container start.
|
|
116
121
|
# ==============================================================================
|
|
117
|
-
FROM oven/bun:1.4.
|
|
122
|
+
FROM oven/bun:1.4.4-slim AS production
|
|
118
123
|
|
|
119
124
|
WORKDIR /usr/src/app
|
|
120
125
|
|
|
@@ -124,7 +129,7 @@ ENV NODE_ENV=production
|
|
|
124
129
|
# OCI image metadata (https://github.com/opencontainers/image-spec/blob/main/annotations.md)
|
|
125
130
|
ARG APP_VERSION
|
|
126
131
|
LABEL org.opencontainers.image.title="hn-mcp-server"
|
|
127
|
-
LABEL org.opencontainers.image.description="MCP server for Hacker News
|
|
132
|
+
LABEL org.opencontainers.image.description="MCP server for Hacker News: feeds, threads, users, and search via Firebase and Algolia APIs"
|
|
128
133
|
LABEL org.opencontainers.image.source="https://github.com/cyanheads/hn-mcp-server"
|
|
129
134
|
LABEL org.opencontainers.image.licenses="Apache-2.0"
|
|
130
135
|
LABEL org.opencontainers.image.version="${APP_VERSION}"
|
|
@@ -136,6 +141,7 @@ COPY --from=deps /usr/src/app/node_modules ./node_modules
|
|
|
136
141
|
|
|
137
142
|
# Copy the compiled application code from the build stage
|
|
138
143
|
COPY --from=build /usr/src/app/dist ./dist
|
|
144
|
+
COPY --from=build /usr/src/app/skills ./skills
|
|
139
145
|
|
|
140
146
|
# The 'oven/bun' image already provides a non-root user named 'bun'.
|
|
141
147
|
# We will use this existing user for enhanced security.
|
package/README.md
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
|
|
8
8
|
<div align="center">
|
|
9
9
|
|
|
10
|
-
[](./CHANGELOG.md) [](./LICENSE) [](https://github.com/users/cyanheads/packages/container/package/hn-mcp-server) [](https://modelcontextprotocol.io/) [](https://www.npmjs.com/package/@cyanheads/hn-mcp-server) [](https://www.typescriptlang.org/) [](https://bun.sh/)
|
|
11
11
|
|
|
12
12
|
</div>
|
|
13
13
|
|
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
|
|
30
30
|
## Overview
|
|
31
31
|
|
|
32
|
-
|
|
32
|
+
Hacker News feeds, threads, and profiles. Browse ranked feeds, read full comment threads, look up users, and search stories, comments, polls, and jobs by keyword, author, date, or score.
|
|
33
33
|
|
|
34
34
|
### Tools
|
|
35
35
|
|
|
@@ -40,48 +40,60 @@ Feeds, threads, and profiles from the Hacker News Firebase API and Algolia Searc
|
|
|
40
40
|
| `hn_get_user` | Fetch a user profile with karma, about, and optionally a page of resolved submissions |
|
|
41
41
|
| `hn_search_content` | Search stories, comments, polls, and jobs via Algolia by keyword, by filters alone, or both — type, author, parent story, date range, and minimum points |
|
|
42
42
|
|
|
43
|
+
### Agent skill
|
|
44
|
+
|
|
45
|
+
| Skill | Description |
|
|
46
|
+
|:---|:---|
|
|
47
|
+
| [`hn-guide`](skills/hn-guide/SKILL.md) | How to find a link's thread, search without Algolia's fuzzy matches, read large comment trees in full, and search what one user said. Served over MCP as `skill://hn-guide/SKILL.md` and shipped in the npm package |
|
|
48
|
+
|
|
43
49
|
## Capability reference
|
|
44
50
|
|
|
45
51
|
### `hn_get_stories` <sub>tool</sub>
|
|
46
52
|
|
|
47
|
-
- Six feed types: `top`, `new`, `best`, `ask`, `show`, `jobs`; `count` (
|
|
53
|
+
- Six feed types: `top`, `new`, `best`, `ask`, `show`, `jobs`; `count` (default 30) and `offset` for pagination. One call serves at most 100 stories; a `count` up to 1,000 is served at 100, with a `notice` naming the next `offset`
|
|
48
54
|
- Returns id, type, title, url, domain, score, author, timestamp, comment count, and body text — each field omitted (not null) when HN doesn't provide it
|
|
49
55
|
- Enrichment reports `total`, `offset`, and `hasMore`; while more stories remain, `truncated` is set and `notice` names the next `offset`, and a `notice` explains empty pages (empty feed, offset past end, or every item on the page deleted/flagged). The last page carries no truncation
|
|
50
|
-
- Items whose fetch failed after retries are listed in `failedIds` with a `notice` naming the retry; a page where every item failed returns the classified upstream error instead of an empty list
|
|
56
|
+
- Items whose fetch failed after retries, or ran past the call's 50-second time budget, are listed in `failedIds` with a `notice` naming the retry; a page where every item failed returns the classified upstream error instead of an empty list
|
|
51
57
|
|
|
52
58
|
---
|
|
53
59
|
|
|
54
60
|
### `hn_get_thread` <sub>tool</sub>
|
|
55
61
|
|
|
56
|
-
- `itemId` plus `depth` (
|
|
62
|
+
- `itemId` plus `depth` (default 3; 0 returns the item with no comments) and `maxComments` (default 50) capping one response across all levels, alongside a fixed 64,000-byte budget on each response surface (all `content[]` text, `nextCursor` included, and the `structuredContent` JSON) that cuts only between comments and always returns a page's first comment whole. One call resolves at most 10 levels and 200 comments; a `depth` up to 100 is served at 10 and a `maxComments` up to 1,000 at 200, with a `notice` naming the comment to pass as `itemId` or the `nextCursor` that reaches the rest
|
|
57
63
|
- Breadth-first traversal ranked like HN — top-ranked top-level comments resolve first, replies fill in only after the level above is exhausted
|
|
58
|
-
- Resumable: a response stopped by `maxComments`, the byte budget,
|
|
59
|
-
- The root carries its relationships and state: `parent` for a comment, `poll` for a poll option, `parts` and resolved `options` (text and votes, at every depth) for a poll, and `deleted`/`dead` markers. The `content[]` heading names the type — a title, `Comment by <author>`, `Poll option by <author> on poll <id>` — and marks a deleted or dead root
|
|
60
|
-
- Flat comment list carries `depth`/`parentId` for tree reconstruction, plus `childCount` and an `isOp` flag when the comment author
|
|
61
|
-
- `truncated` and `truncationReason` (`count`, `size`, `rate_limited`, or `depth` when replies lie below the depth limit) are set only while comments remain unread — never on a terminal page, including a thread that loads in full at exactly the cap. `notice` reports deleted/dead comments omitted during traversal and the next step: the cursor, or a larger `depth` or a comment id as `itemId
|
|
62
|
-
- Comments and poll options whose fetch failed after retries are listed in `failedIds`, and `notice` names them with the retry; failed comments ride in `nextCursor`, so paging on retries them rather than skipping them. The root item is still returned, and a failure is never passed off as a `maxComments`/`depth` limit
|
|
64
|
+
- Resumable: a response stopped by `maxComments`, the byte budget, an upstream rate limit, or the call's 50-second time budget returns `nextCursor`; passing it back as `cursor` with the same `itemId` continues at the next unseen comment. The cursor carries the unvisited comments themselves, so re-ranked replies cannot shift it, and the server keeps no session state. A cursor the tool did not issue, an altered one, or one passed with a different `itemId` fails with `invalid_cursor`
|
|
65
|
+
- The root carries its relationships and state: `parent` and `storyId` (the story or poll the discussion belongs to) for a comment, `poll` for a poll option, `parts` and resolved `options` (text and votes, at every depth) for a poll, and `deleted`/`dead` markers. The `content[]` heading names the type — a title, `Comment by <author>`, `Poll option by <author> on poll <id>` — and marks a deleted or dead root
|
|
66
|
+
- Flat comment list carries `depth`/`parentId` for tree reconstruction, plus `childCount` and an `isOp` flag when the comment author submitted the thread's story — on a comment root, the story at `storyId`, never the comment's own author. Dead and deleted comments are left out, but their live replies are still returned at their true `depth`, with `parentId` naming the omitted comment
|
|
67
|
+
- `truncated` and `truncationReason` (`count`, `size`, `rate_limited`, `time`, or `depth` when replies lie below the depth limit) are set only while comments remain unread — never on a terminal page, including a thread that loads in full at exactly the cap. `notice` reports deleted/dead comments omitted during traversal and the next step: the cursor, or a larger `depth` or a comment id as `itemId`, naming by ID any omitted comment whose replies the depth limit cut
|
|
68
|
+
- Comments and poll options whose fetch failed after retries or ran past the call's time budget are listed in `failedIds`, and `notice` names them with the retry; failed comments ride in `nextCursor`, so paging on retries them rather than skipping them. The root item is still returned, and a failure is never passed off as a `maxComments`/`depth` limit
|
|
63
69
|
|
|
64
70
|
---
|
|
65
71
|
|
|
66
72
|
### `hn_get_user` <sub>tool</sub>
|
|
67
73
|
|
|
68
|
-
- `username` is case-sensitive and trimmed; `includeSubmissions` (default false) resolves recent submissions, with `submissionCount` (
|
|
74
|
+
- `username` is case-sensitive and trimmed; `includeSubmissions` (default false) resolves recent submissions, with `submissionCount` (default 10) and `submissionOffset` paging through a long history. One call resolves at most 50 submissions; a `submissionCount` up to 1,000 is served at 50, with a `notice` naming the next `submissionOffset`
|
|
69
75
|
- Profile includes karma, creation date, and about text (HTML stripped); submissions filter out dead/deleted items
|
|
70
76
|
- A comment submission carries its `parent` and a poll-option submission its `poll`, so either links back to what it answered
|
|
71
77
|
- Enrichment echoes `submissionOffset` and the offset to send next, or a notice when the requested offset is past the end of the history
|
|
72
|
-
- Submissions whose fetch failed after retries are listed in `failedIds` with a `notice` naming the retry; a window where every submission failed returns the classified upstream error
|
|
78
|
+
- Submissions whose fetch failed after retries, or that the call's 50-second time budget cut, are listed in `failedIds` with a `notice` naming the retry (and the budget, when it cut them); a window where every submission failed returns the classified upstream error — `Timeout` when the budget cut them all
|
|
79
|
+
- Each response surface is held to a fixed 64,000-byte budget: an over-budget page keeps every submission and cuts the longest bodies to one shared length, flagging each with `textTruncated` and pointing to `hn_get_thread` for the whole text
|
|
73
80
|
|
|
74
81
|
---
|
|
75
82
|
|
|
76
83
|
### `hn_search_content` <sub>tool</sub>
|
|
77
84
|
|
|
78
|
-
- Free-text `query` plus `tags` (`story`/`comment`/`poll`/`job`/`ask_hn`/`show_hn`/`front_page`), `author
|
|
85
|
+
- Free-text `query` — typo-tolerant, with the last term also matching as a prefix; wrap a term in double quotes to match it exactly and put `-` before one to exclude it — plus `tags` (`story`/`comment`/`poll`/`job`/`ask_hn`/`show_hn`/`front_page`), `author` (the exact, case-sensitive username), `storyId`, `dateRange`, and `minPoints` filters; `sort` by relevance or date; `count` (default 30) and `page` for pagination. One call serves at most 50 hits; a `count` up to 1,000 is served as the page of 50 starting at the requested page's first hit, with a `notice` naming the `count: 50` page to pass next; a non-zero `page` whose first hit begins no page of 50 fails with `count_page_unaligned`, naming a `count` and `page` that start there and, when that count is under 25, the page of 50 that holds that hit
|
|
86
|
+
- `tags: "front_page"` is the front page right now (about 30 stories), never past front pages; for an earlier window, use `tags: "story"` with `dateRange` and `minPoints`
|
|
79
87
|
- `query` is optional when a filter is set — list Ask HN, Show HN, polls, or jobs on their own, or pass a story's `storyId` with `tags: "comment"` to search within one thread. No query and no filter fails with `missing_query_or_filter`
|
|
88
|
+
- To check whether a page was discussed, pass its URL alone as `query`: the leading `http://`, `https://`, or `www.` is dropped before searching, so submissions under either scheme, with or without `www.`, all match. The output `query` and the notice show what was searched
|
|
80
89
|
- `dateRange` bounds take ISO 8601 (`YYYY`, `YYYY-MM`, `YYYY-MM-DD`, or a date-time with optional offset), read as UTC and both exclusive; an empty or out-of-order range fails with `invalid_date_range`
|
|
81
90
|
- `minPoints` applies to stories and polls — comments and jobs carry no points, so pairing it with `tags: "comment"` or `"job"` fails with `min_points_unscored_type`
|
|
82
|
-
- `view: "compact"` drops the two body-text fields (`text`, `highlights.text`), which otherwise repeat a long comment twice per hit — pass a hit id to `hn_get_thread` to read the body
|
|
83
|
-
-
|
|
84
|
-
-
|
|
91
|
+
- `view: "compact"` drops the two body-text fields (`text`, `highlights.text`), which otherwise repeat a long comment twice per hit — pass a hit id to `hn_get_thread` to read the body. In `full`, a page over 64,000 bytes per response surface drops `highlights.text` from every hit (`highlightsTextOmitted`), then cuts the longest bodies to one shared length (`textTruncated`, with an `hn_get_thread` pointer) — every hit stays
|
|
92
|
+
- Each hit carries its `type` (`story`, `comment`, `poll`, `pollopt`, `job`) when Algolia records one. Untagged searches also return poll options, which carry only an id, author, vote count, and date — `hn_get_thread` reads an option's text and poll. A poll hit has no `storyId`; its own `id` is the discussion root
|
|
93
|
+
- Job descriptions come back as `text`, though keywords don't search them
|
|
94
|
+
- Highlight metadata (`highlights.title`, `highlights.text`, `matchedWords`) shows which terms matched and where; `highlights.text` is the matched body in full with `<em>` markers
|
|
95
|
+
- Enrichment echoes the applied `criteria` — each filter set (`author` trimmed, `dateRange` as the exclusive UTC bounds applied, to the second), plus `sort`, `count`, and `view` with defaults filled — so a saved result says what it answers
|
|
96
|
+
- Enrichment reports `totalHits`, `page`, and the actual reachable `totalPages` — not derived from `totalHits`, since broad queries report far more hits than Algolia will serve. `totalHitsExact: false` marks `totalHits` as an estimate, and `reachableHits: 1000` marks a search that matches more than Algolia's 1,000-hit ceiling; the last page of such a search gets a notice naming the ceiling and narrower `dateRange` windows to reach the rest. While more pages remain, `truncated` is set and `notice` names the next `page`; a page past the end gets a notice naming the last valid page (or `page: 0` past the ceiling)
|
|
85
97
|
|
|
86
98
|
## Features
|
|
87
99
|
|
|
@@ -97,10 +109,10 @@ HN-specific:
|
|
|
97
109
|
|
|
98
110
|
Agent-friendly output:
|
|
99
111
|
|
|
100
|
-
- Graceful partial failure — an item whose fetch fails after retries is reported by ID in `failedIds`, apart from deleted, dead, or nonexistent items, rather than silently shrinking the result; `hn_get_thread` also counts the deleted and dead comments it drops, and a rate-limited item stops the batch instead of sending every remaining item through its own retry ladder
|
|
112
|
+
- Graceful partial failure — an item whose fetch fails after retries is reported by ID in `failedIds`, apart from deleted, dead, or nonexistent items, rather than silently shrinking the result; each `hn_get_thread`, `hn_get_stories`, and `hn_get_user` call runs under one 50-second time budget, so hung fetches cannot hold it past an MCP client's 60-second timeout; `hn_get_thread` also counts the deleted and dead comments it drops, and a rate-limited item stops the batch instead of sending every remaining item through its own retry ladder
|
|
101
113
|
- Discriminated output contracts — typed error reasons (`item_not_found`, `upstream_rate_limited`, `upstream_html`, …) with per-reason recovery text (a rate limit passes on the upstream's `Retry-After` as `retryAfter`), and a `depth`/`parentId` pair on every comment so callers reconstruct the tree without guessing nesting
|
|
102
|
-
- Pagination provenance — every paged listing echoes the offset it used (`offset`, `submissionOffset`, `page`) plus the exact next-offset value in `notice`, and `hn_get_thread` returns a self-contained `nextCursor`, so an agent can resume without recomputing state
|
|
103
|
-
- Response shaping — HTML stripping, URL normalization, and domain extraction remove upstream markup noise; `hn_search_content`'s `view: "compact"` drops the two body-text fields that otherwise duplicate a hit's full text
|
|
114
|
+
- Pagination provenance — every paged listing echoes the offset it used (`offset`, `submissionOffset`, `page`) plus the exact next-offset value in `notice`, `hn_search_content` also echoes the `criteria` it searched with, and `hn_get_thread` returns a self-contained `nextCursor`, so an agent can resume without recomputing state
|
|
115
|
+
- Response shaping — HTML stripping, URL normalization, and domain extraction remove upstream markup noise; `hn_search_content`'s `view: "compact"` drops the two body-text fields that otherwise duplicate a hit's full text, and a 64,000-byte budget on each response surface cuts the longest bodies of an over-budget page
|
|
104
116
|
- Fenced upstream text — in `content[]`, every line of a body is block-quoted and titles are escaped only where they could break the surrounding Markdown, so a comment cannot pass for a server-authored line
|
|
105
117
|
|
|
106
118
|
## Getting started
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "hn_get_thread returns live replies below dead and deleted comments, marks OP against the story's author on comment roots, and issues packed cursors; hn_search_content discloses estimated totals, echoes its criteria, and types its hits; an over-cap count is served at the cap."
|
|
3
|
+
breaking: false
|
|
4
|
+
security: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# 0.5.22 — 2026-10-18
|
|
8
|
+
|
|
9
|
+
## Changed
|
|
10
|
+
|
|
11
|
+
- **`hn_get_thread` adds `item.storyId`**: a comment root names the story or poll its discussion belongs to, rendered as `story:<id>` in `content[]`. Absent when the story could not be found; `notice` says why. (#42)
|
|
12
|
+
- **`hn_search_content` adds `criteria`**: the applied filters plus `sort`, `count`, and `view` with defaults filled, `author` trimmed and `dateRange` as the exclusive UTC bounds sent, echoed in `structuredContent` and as a `**criteria:**` line in `content[]`. (#35)
|
|
13
|
+
- **`hn_search_content` adds `totalHitsExact` and `reachableHits`**: `totalHitsExact: false` marks `totalHits` as an estimate, and `reachableHits: 1000` marks a search matching more than Algolia serves; the last reachable page's `notice` names the ceiling and narrower `dateRange` windows. (#34)
|
|
14
|
+
- **`hn_search_content` hits carry `type`**: `story`, `comment`, `poll`, `pollopt`, or `job`, when Algolia records one. A poll option renders as `Poll option by <author>` pointing to `hn_get_thread`. (#41)
|
|
15
|
+
- **Over-cap inputs are served at the cap instead of rejected**: `hn_get_stories` `count` up to 1,000 at 100, `hn_get_user` `submissionCount` up to 1,000 at 50, `hn_get_thread` `depth` up to 100 at 10 and `maxComments` up to 1,000 at 200, `hn_search_content` `count` up to 1,000 at 50. `cap` reports the value served and `notice` names the lever for the rest. Values above those ceilings are still rejected. (#45)
|
|
16
|
+
- **`hn_search_content` serves an over-cap `count` from the requested page's first hit**: the search runs as page `page × count / 50` at 50, and `page`, `totalPages`, and `criteria.count` describe that page of 50. (#45)
|
|
17
|
+
- **`hn_search_content` adds the error reason `count_page_unaligned`**: a `count` above 50 with a non-zero `page` whose first hit begins no page of 50 fails with it, naming a `count` and `page` that start at that hit. (#45)
|
|
18
|
+
- **`hn_get_thread` `nextCursor` is packed**: a base64url varint encoding that also carries the resolved story. Cursors issued by earlier releases still resume, and a cursor longer than 150,000 characters is rejected as `invalid_cursor`. (#43)
|
|
19
|
+
- **`hn_get_thread` rejects a cursor it did not issue** with the declared `invalid_cursor` reason, so the rejection logs at `notice` with the reason attached. (#36)
|
|
20
|
+
- **`hn_search_content` drops a leading `http://`, `https://`, or `www.` from a query that is a URL alone**, so submissions under either scheme, with or without `www.`, match. The output `query` and `notice` show what was searched. (#38)
|
|
21
|
+
- **`hn_search_content` job descriptions** (`job_text`) are returned as `text`; they are not keyword-searched or highlighted. (#41)
|
|
22
|
+
- **`hn_search_content` names the `author` casing rule** when an author-filtered first page is empty: `author` is an exact, case-sensitive match. (#39)
|
|
23
|
+
- **`hn_search_content` scopes `tags: "front_page"`** in the `notice` on an empty first page or whenever `dateRange` is set: it is the current front page only, with `tags: "story"` plus `dateRange` and `minPoints` as the alternative. (#40)
|
|
24
|
+
- **`hn_search_content` escapes the query** in the `content[]` heading and no-results line. (#35)
|
|
25
|
+
- **Framework sync**: `framework-skills/` synced to 0.13.15, `.env.example` lists `LOG_LLM_INTERACTIONS`, and the `check-framework-antipatterns.ts` patterns use POSIX space classes.
|
|
26
|
+
- **Tests**: worst-case timing checks measure the test thread's CPU time instead of wall clock. (#44)
|
|
27
|
+
|
|
28
|
+
## Fixed
|
|
29
|
+
|
|
30
|
+
- **`hn_get_thread` returns live replies below dead and deleted comments** at their true `depth`, with `parentId` naming the omitted comment. The comment stays out of `comments[]` and in the notice's counts; where the depth limit cuts its replies, `notice` names it by ID to pass as `itemId`. (#33)
|
|
31
|
+
- **`descendants` and `totalAvailable` are described as live-comment counts** in `hn_get_stories`, `hn_get_user`, and `hn_get_thread`. (#33)
|
|
32
|
+
- **`isOp` on a comment root marks replies by the story's author**, where it marked the root comment's author. The lookup follows at most 64 parent links and ends 20 seconds after the call starts. (#42)
|
|
33
|
+
- **A caller abort during a retry's backoff ends a `fetchItems` batch** instead of recording a failed slot. (#42)
|
|
34
|
+
|
|
35
|
+
## Dependencies
|
|
36
|
+
|
|
37
|
+
- `@cyanheads/mcp-ts-core` ^0.13.12 → ^0.13.15 (0.13.13: error envelopes drop `data.rootCause` and filesystem storage errors name the key, not the storage root; 0.13.14: tool-argument pre-validation repairs numeric and boolean strings, lone strings for arrays, and null optionals; 0.13.15: DuckDB canvases run with external access off and ZodError `data.issues` is bounded)
|
|
38
|
+
- `@modelcontextprotocol/server` 2.2.0 → 2.3.1 (transitive)
|
|
39
|
+
- `pino-pretty` ^13.1.3 → ^13.2.0
|
|
40
|
+
- `zod` ^4.6.5 → ^4.6.7
|
|
41
|
+
- Dev: `@types/node` ^26.6.4 → ^26.6.5
|
|
42
|
+
- Dev: `@vitest/coverage-istanbul` ^5.0.3 → ^5.0.5
|
|
43
|
+
- Dev: `ignore` ^7.0.11 → ^7.0.12
|
|
44
|
+
- Dev: `vitest` ^5.0.3 → ^5.0.5
|
|
45
|
+
- `packageManager` bun@1.4.2 → bun@1.4.3; Docker base images `oven/bun` 1.4.2 → 1.4.3
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "hn_search_content, hn_get_user, and hn_get_thread hold each response surface to 64,000 bytes; hn_get_thread, hn_get_stories, and hn_get_user run under one 50-second time budget; the hn-guide agent skill is served as a skill:// resource."
|
|
3
|
+
breaking: false
|
|
4
|
+
security: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# 0.6.0 — 2026-10-28
|
|
8
|
+
|
|
9
|
+
## Added
|
|
10
|
+
|
|
11
|
+
- **Published `hn-guide` Agent Skill**: `resources/list` now lists `skill://hn-guide/SKILL.md` and `resources/templates/list` lists the `skill://{+path}` template, served through mcp-ts-core 0.13.18's `createApp({ skills })`. The skill also ships in the npm package and the Docker image.
|
|
12
|
+
- **Root `plugin.json` and `mcp.json`**: the Agent Plugins 1.0.0 manifest pair, alongside the Claude and Codex plugin overlays.
|
|
13
|
+
|
|
14
|
+
## Changed
|
|
15
|
+
|
|
16
|
+
- **`hn_search_content` `query` description** documents typo tolerance, prefix matching on the last term, `"quoted"` exact terms, and `-` exclusion. `highlights.text` is described as the matched body in full, not a snippet.
|
|
17
|
+
- **Framework rendering in `content[]`** (mcp-ts-core 0.13.16–0.13.18): error text and trailer text gain Markdown escapes, every line of a `notice` is block-quoted, and string trailer values such as `nextCursor` and `truncationReason` render as code spans. `structuredContent` is unchanged.
|
|
18
|
+
- **`.mcpb` bundle** leaves out repo-local root paths and build-only package files; the agent-doc strip is anchored at each package root so MCP SDK 2.4's `dist/ext/skills/` stays in the bundle.
|
|
19
|
+
- **Framework sync**: `framework-skills/` synced to 0.13.18 (adds `add-skill`), `scripts/` and `.github/ISSUE_TEMPLATE/bug_report.yml` resynced, and `bunfig.toml` `minimumReleaseAge` is 1 day (was 3).
|
|
20
|
+
|
|
21
|
+
## Fixed
|
|
22
|
+
|
|
23
|
+
- **`hn_search_content` holds the `full` view to 64,000 bytes** on all of `content[]` and on `structuredContent`, each. An over-budget page drops `highlights.text` from every hit (`highlightsTextOmitted: true`), then cuts the longest `text` bodies to one shared limit (`textTruncated: true`, with an `hn_get_thread` pointer in `content[]`). Every hit stays, and `notice` names the budget and the cut ids. (#46)
|
|
24
|
+
- **`hn_get_user` holds a submissions page to the same 64,000 bytes per surface**: the longest submission bodies are cut to one shared limit and flagged `textTruncated`, every submission stays, and `user.about` is never cut. (#49)
|
|
25
|
+
- **`hn_get_thread` counts the whole response against its `size` stop**: `content[]` text with the trailer and `nextCursor`, and the `structuredContent` JSON, are each held to 64,000 bytes. A page's first comment is still returned whole. (#50)
|
|
26
|
+
- **`hn_get_thread`, `hn_get_stories`, and `hn_get_user` run under one 50-second time budget** counted from the call's start. A fetch the budget cuts or leaves unstarted is listed in `failedIds` and `notice` names the budget; `hn_get_thread` stops with `truncationReason: "time"` and a `nextCursor`, and a stories or user call where the budget cuts every fetch fails with `Timeout`. (#47)
|
|
27
|
+
|
|
28
|
+
## Dependencies
|
|
29
|
+
|
|
30
|
+
- `@cyanheads/mcp-ts-core` ^0.13.15 → ^0.13.18 (0.13.16: Markdown-escaped error and trailer text; 0.13.17: `@modelcontextprotocol/server` 2.4; 0.13.18: `createApp({ skills })`, code-span trailer values)
|
|
31
|
+
- `@modelcontextprotocol/server` 2.3.1 → 2.4.0 (via the framework)
|
|
32
|
+
- `@modelcontextprotocol/core` 2.3.1 → 2.4.0 (transitive)
|
|
33
|
+
- `@opentelemetry/api` 1.9.1 → 1.10.0 (transitive)
|
|
34
|
+
- `jose` 6.2.12 → 6.2.13 (transitive)
|
|
35
|
+
- Dev: `@biomejs/biome` ^2.5.15 → ^2.6.3
|
|
36
|
+
- Dev: `ignore` ^7.0.12 → ^7.0.14
|
|
37
|
+
- Dev: `tsc-alias` ^1.9.7 → ^1.9.9
|
|
38
|
+
- `packageManager` bun@1.4.3 → bun@1.4.4; Docker base images `oven/bun` 1.4.3 → 1.4.4
|
package/dist/index.js
CHANGED
|
@@ -16,6 +16,7 @@ await createApp({
|
|
|
16
16
|
instructions: 'Use the hn_* tools to access Hacker News via the Firebase API and Algolia search: ranked feeds; search by keyword, by type/author/story/date/score filters alone, or both; user profiles; and items with their comment trees. Items are addressed by integer ID, reused across tools and item types (story, comment, job, poll, pollopt); passing a comment id to hn_get_thread drills into that subtree. Usernames are case-sensitive; HN sparsely populates fields, so treat absent values as unknown.',
|
|
17
17
|
landing: { requireAuth: false },
|
|
18
18
|
sessionMode: 'stateless',
|
|
19
|
+
skills: 'skills',
|
|
19
20
|
setup() {
|
|
20
21
|
initHnService();
|
|
21
22
|
},
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AACA;;;GAGG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,OAAO,EAAE,UAAU,EAAE,MAAM,oDAAoD,CAAC;AAChF,OAAO,EAAE,SAAS,EAAE,MAAM,mDAAmD,CAAC;AAC9E,OAAO,EAAE,OAAO,EAAE,MAAM,iDAAiD,CAAC;AAC1E,OAAO,EAAE,QAAQ,EAAE,MAAM,uDAAuD,CAAC;AACjF,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAE5D,MAAM,SAAS,CAAC;IACd,IAAI,EAAE,eAAe;IACrB,KAAK,EAAE,eAAe;IACtB,KAAK,EAAE,CAAC,UAAU,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,CAAC;IACjD,YAAY,EACV,0eAA0e;IAC5e,OAAO,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE;IAC/B,WAAW,EAAE,WAAW;IACxB,KAAK;QACH,aAAa,EAAE,CAAC;IAClB,CAAC;CACF,CAAC,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AACA;;;GAGG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,OAAO,EAAE,UAAU,EAAE,MAAM,oDAAoD,CAAC;AAChF,OAAO,EAAE,SAAS,EAAE,MAAM,mDAAmD,CAAC;AAC9E,OAAO,EAAE,OAAO,EAAE,MAAM,iDAAiD,CAAC;AAC1E,OAAO,EAAE,QAAQ,EAAE,MAAM,uDAAuD,CAAC;AACjF,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAE5D,MAAM,SAAS,CAAC;IACd,IAAI,EAAE,eAAe;IACrB,KAAK,EAAE,eAAe;IACtB,KAAK,EAAE,CAAC,UAAU,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,CAAC;IACjD,YAAY,EACV,0eAA0e;IAC5e,OAAO,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE;IAC/B,WAAW,EAAE,WAAW;IACxB,MAAM,EAAE,QAAQ;IAChB,KAAK;QACH,aAAa,EAAE,CAAC;IAClB,CAAC;CACF,CAAC,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"get-stories.tool.d.ts","sourceRoot":"","sources":["../../../../src/mcp-server/tools/definitions/get-stories.tool.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAQ,CAAC,EAAE,MAAM,wBAAwB,CAAC;AACjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;
|
|
1
|
+
{"version":3,"file":"get-stories.tool.d.ts","sourceRoot":"","sources":["../../../../src/mcp-server/tools/definitions/get-stories.tool.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAQ,CAAC,EAAE,MAAM,wBAAwB,CAAC;AACjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAoBjE,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA+QrB,CAAC"}
|
|
@@ -5,9 +5,12 @@
|
|
|
5
5
|
import { tool, z } from '@cyanheads/mcp-ts-core';
|
|
6
6
|
import { JsonRpcErrorCode } from '@cyanheads/mcp-ts-core/errors';
|
|
7
7
|
import { escapeInline, quoteBody } from '../markdown-escape.js';
|
|
8
|
-
import {
|
|
9
|
-
|
|
10
|
-
|
|
8
|
+
import { servedAtCap } from '../served-at-cap.js';
|
|
9
|
+
import { CALL_BUDGET_MS, decodeHtmlEntities, extractDomain, getHnService, normalizeUrl, settlePage, stripHtml, timeBudgetCutSentence, } from '../../../services/hn/hn-service.js';
|
|
10
|
+
/** Most stories one call serves; a larger `count` is served at this cap. */
|
|
11
|
+
const COUNT_CAP = 100;
|
|
12
|
+
/** Largest `count` accepted; anything above it is rejected. */
|
|
13
|
+
const COUNT_CEILING = 1000;
|
|
11
14
|
export const getStories = tool('hn_get_stories', {
|
|
12
15
|
description: 'Fetch stories from an HN feed (top, new, best, ask, show, jobs), with title, URL, score, author, and comment count for each story.',
|
|
13
16
|
annotations: { readOnlyHint: true },
|
|
@@ -60,9 +63,9 @@ export const getStories = tool('hn_get_stories', {
|
|
|
60
63
|
.number()
|
|
61
64
|
.int()
|
|
62
65
|
.min(1)
|
|
63
|
-
.max(
|
|
66
|
+
.max(COUNT_CEILING)
|
|
64
67
|
.default(30)
|
|
65
|
-
.describe(
|
|
68
|
+
.describe(`Number of stories to return, at most ${COUNT_CAP} per call. A larger value is served at ${COUNT_CAP}, and the notice names the offset for the next page. Larger counts take longer.`),
|
|
66
69
|
offset: z
|
|
67
70
|
.number()
|
|
68
71
|
.int()
|
|
@@ -100,7 +103,10 @@ export const getStories = tool('hn_get_stories', {
|
|
|
100
103
|
.number()
|
|
101
104
|
.optional()
|
|
102
105
|
.describe('Unix timestamp when provided by HN. Omitted when unknown.'),
|
|
103
|
-
descendants: z
|
|
106
|
+
descendants: z
|
|
107
|
+
.number()
|
|
108
|
+
.optional()
|
|
109
|
+
.describe("HN's count of live comments in the thread (descendants); dead and deleted comments are not counted. Absent for jobs."),
|
|
104
110
|
text: z
|
|
105
111
|
.string()
|
|
106
112
|
.optional()
|
|
@@ -121,24 +127,31 @@ export const getStories = tool('hn_get_stories', {
|
|
|
121
127
|
.optional()
|
|
122
128
|
.describe('True when more stories remain beyond this page (hasMore). Absent on the last page of the feed.'),
|
|
123
129
|
shown: z.number().optional().describe('Number of stories returned on this page.'),
|
|
124
|
-
cap: z
|
|
130
|
+
cap: z
|
|
131
|
+
.number()
|
|
132
|
+
.optional()
|
|
133
|
+
.describe(`The count value served: as passed, or ${COUNT_CAP} when count was above that cap.`),
|
|
125
134
|
failedIds: z
|
|
126
135
|
.array(z.number())
|
|
127
136
|
.optional()
|
|
128
|
-
.describe(
|
|
137
|
+
.describe(`IDs on this page whose fetch failed after retries or ran past the call's ${CALL_BUDGET_MS / 1000}-second time budget. They are not deleted or missing and may load on a later call: retry the page with the same offset, or pass an ID to hn_get_thread to fetch that story alone. Absent when every item on the page loaded.`),
|
|
129
138
|
notice: z
|
|
130
139
|
.string()
|
|
131
140
|
.optional()
|
|
132
|
-
.describe(
|
|
141
|
+
.describe(`Agent guidance: the offset to pass for the next page while more stories remain, the IDs that failed to load and how to retry them (naming the call's ${CALL_BUDGET_MS / 1000}-second time budget when it cut them), or why a page came back empty — offset past the end of the feed, an empty feed, or every item on the page deleted or flagged — noting when count was served at its per-call cap. Absent on the last page of a non-empty result with no failed IDs.`),
|
|
133
142
|
},
|
|
134
143
|
enrichmentTrailer: {
|
|
135
144
|
failedIds: { render: (ids) => `**Failed to load:** ${(ids ?? []).join(', ')}` },
|
|
136
145
|
},
|
|
137
146
|
async handler(input, ctx) {
|
|
138
147
|
const hn = getHnService();
|
|
139
|
-
|
|
140
|
-
const
|
|
141
|
-
const
|
|
148
|
+
/** One budget for the feed and every item fetch after it. */
|
|
149
|
+
const deadline = Date.now() + CALL_BUDGET_MS;
|
|
150
|
+
const feedIds = await hn.fetchFeed(input.feed, ctx, deadline);
|
|
151
|
+
const count = Math.min(input.count, COUNT_CAP);
|
|
152
|
+
const sliced = feedIds.slice(input.offset, input.offset + count);
|
|
153
|
+
const slots = await hn.fetchItems(sliced, ctx, deadline);
|
|
154
|
+
const { items, failedIds } = settlePage(slots);
|
|
142
155
|
const stories = items.map((item) => {
|
|
143
156
|
const url = normalizeUrl(item.url);
|
|
144
157
|
const domain = extractDomain(url);
|
|
@@ -161,7 +174,7 @@ export const getStories = tool('hn_get_stories', {
|
|
|
161
174
|
failed: failedIds.length,
|
|
162
175
|
});
|
|
163
176
|
const total = feedIds.length;
|
|
164
|
-
const nextOffset = input.offset +
|
|
177
|
+
const nextOffset = input.offset + count;
|
|
165
178
|
const hasMore = nextOffset < total;
|
|
166
179
|
ctx.enrich({
|
|
167
180
|
total,
|
|
@@ -171,18 +184,19 @@ export const getStories = tool('hn_get_stories', {
|
|
|
171
184
|
});
|
|
172
185
|
const deadPageMessage = `No live stories on this page of the ${input.feed} feed (offset:${input.offset}, total:${total}). Items may have been deleted or flagged.`;
|
|
173
186
|
const failureMessage = failedIds.length > 0
|
|
174
|
-
? `Could not fetch ${failedIds.length} of ${sliced.length} items on this page (id${failedIds.length === 1 ? '' : 's'} ${failedIds.join(', ')})
|
|
187
|
+
? `Could not fetch ${failedIds.length} of ${sliced.length} items on this page (id${failedIds.length === 1 ? '' : 's'} ${failedIds.join(', ')}).${timeBudgetCutSentence(slots)} Retry with offset: ${input.offset}, or pass an id as itemId to hn_get_thread to fetch that story alone.`
|
|
175
188
|
: undefined;
|
|
176
189
|
if (hasMore) {
|
|
177
|
-
const raiseCount = input.count <
|
|
190
|
+
const raiseCount = input.count < COUNT_CAP ? `, or raise count (max ${COUNT_CAP})` : '';
|
|
178
191
|
const nextPage = `Pass offset: ${nextOffset} for the next page${raiseCount}.`;
|
|
179
192
|
const pageStatus = stories.length === 0 && !failureMessage
|
|
180
193
|
? deadPageMessage
|
|
181
194
|
: `Showing items ${input.offset + 1}–${nextOffset} of ${total} in the ${input.feed} feed.`;
|
|
195
|
+
const overCap = input.count > COUNT_CAP ? servedAtCap('count', input.count, COUNT_CAP) : '';
|
|
182
196
|
ctx.enrich.truncated({
|
|
183
197
|
shown: stories.length,
|
|
184
|
-
cap:
|
|
185
|
-
guidance: [pageStatus, failureMessage, nextPage].filter(Boolean).join(' '),
|
|
198
|
+
cap: count,
|
|
199
|
+
guidance: [pageStatus, overCap, failureMessage, nextPage].filter(Boolean).join(' '),
|
|
186
200
|
});
|
|
187
201
|
}
|
|
188
202
|
else if (stories.length === 0) {
|