feat: default to hosted noticed.so + document hosted MCP + fix stale tool table#3
Merged
Merged
Conversation
Two things were missing or wrong in the README after the 0.3.0 surface change: 1. The hosted MCP endpoint at https://mcp.noticed.so/api/mcp wasn't documented anywhere. For HTTP-capable clients (Claude Code, Cursor, Claude Desktop, etc.) it's a single-command install with no npx and no env vars. Now documented as the recommended option above the stdio walkthrough. 2. The 'MCP tools' table near the bottom still listed search_network and get_connection_path — the legacy tools from 0.2.x. They're now capability names accessed via execute, not MCP tools. Replaced with the search + execute meta-tools, an example client-side flow, and a short list of what the ~50 chat-safe capabilities cover. Also nested the per-client snippets (Claude Desktop, Cursor, …) under a new 'Stdio MCP server' h3 so the two install paths are clearly distinguished. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Self-hosting noticed isn't realistic for ~100% of users — the value depends on a pre-ingested GHArchive + LinkedIn graph (hundreds of GiB of ClickHouse, paid RapidAPI access, OpenAI/Anthropic keys, NextAuth OAuth apps). The README pretending it's the common case was misleading and added friction for everyone. Changes: - src/api-client.ts: createClientFromEnv() now defaults NOTICED_API_URL to https://www.noticed.so when unset. NOTICED_API_KEY is still required. Self-hosters can override NOTICED_API_URL explicitly. - mcp.json + server.json: drop NOTICED_API_URL from required env; server.json marks it isRequired: false with a clarifying description. - README.md: purge `https://your-instance.noticed.so` from every client snippet (~10 occurrences); update the env-var table; new 'Self-hosting noticed' footnote that keeps the override documented without leading with it. - package.json + server.json: bump 0.3.0 → 0.3.1 (patch — the env-var fallback is a small behavioural addition, not a breaking change). Auto-release workflow (merged in PR #2) will pick up the version change on merge and publish 0.3.1 to npm automatically. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
simaonogueira101
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Three layered fixes — the original docs gaps from this PR plus a behaviour change that makes the docs honest.
1. Default
NOTICED_API_URLto the hosted instance (code change)createClientFromEnv()previously threw ifNOTICED_API_URLwas unset, on the theory that users would self-host. In practice self-hosting is unrealistic — noticed's value depends on a pre-ingested GHArchive + LinkedIn graph (hundreds of GiB of ClickHouse, daily ingestion pipeline, paid RapidAPI access, OpenAI/Anthropic keys, NextAuth OAuth apps). For ~100% of users the env var was friction.After this change:
NOTICED_API_URLdefaults tohttps://www.noticed.so. OnlyNOTICED_API_KEYis required. Self-hosters can still override.Same pattern we already applied to
apps/noticed-mcp/lib/noticed-client.tsin the noticed monorepo.2. Hosted MCP endpoint documented (was missing)
https://mcp.noticed.so/api/mcp(Streamable HTTP) has been live but the README didn't mention it. Adds a "Hosted MCP server (recommended — no install)" section above the stdio walkthrough: one-lineclaude mcp add --transport http …plus URL+headers JSON for every other client (Cursor, Claude Desktop, Zed, VS Code, Windsurf, Cline).3. Stale MCP tools table fixed
The "MCP tools" table at the bottom still listed
search_network+get_connection_pathfrom 0.2.x. After 0.3.0 the MCP surface is two meta-tools (search+execute) backed by ~50 capabilities — the old names are now capability names you invoke viaexecute. Table replaced; client-side flow example added; brief summary of what the chat-safe capabilities cover.Self-hosting
Demoted to a footnote at the end of the README ("Self-hosting noticed"). The override path stays documented without misleading the common case. Points at the noticed source repo for the rare advanced user.
What every stdio snippet looks like now
Before:
After:
Release
Bumps
0.3.0→0.3.1. The auto-release workflow merged in #2 will detect the version change on main and publish to npm automatically.Test plan
npm run lint— cleannpm run check-types— cleannpm test— 32/32 passnpm run build— cleanyour-instance.noticed.soplaceholdersGenerated with Claude Code