Repository navigation
News API MCP: agent setup page - #154
Merged
Merged
Conversation
New page news-api/integrations/mcp-agent-setup, written for the agent doing the setup rather than the person: which path to take for the client it is running in, how to verify the key with one call before touching any config, the defaults that bite, and what each failure means. Mintlify serves it as plain markdown under the .md suffix, so "Read and follow <url>" is the whole onboarding line. On the MCP page itself: the Claude Desktop tab now leads with the Connectors screen (one URL, no Node, no restart) and moves the mcp-remote JSON config into a fallback accordion; the "no space after the colon" rule is scoped to mcp-remote, which is where it comes from; a tip at the top carries the paste-into-your-agent line; troubleshooting and See also point at the new page. llms.txt and sitemap regenerated. Why: an agent in Claude Desktop followed the old page into the JSON config route, could not reach the protected config folder, and handed the person a Terminal script. The Connectors route needs none of that and the hosted server accepts the key in the URL. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
hidden: true in the frontmatter and no docs.json entry: the page stays built and served (including its .md twin, which is what the paste line fetches) but leaves the sidebar, site search, sitemap and search engines. The See also tile on the MCP page goes too; the tip at the top with the paste line stays, since that is how a person reaches it. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Kizy625
approved these changes
Oct 5, 2026
This branch was successfully deployed
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
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.
Why
A user pasted the platform's "Copy setup for my agent" line into Claude Desktop. The agent followed the MCP page into the JSON-config +
mcp-remoteroute, could not reach the protected config folder, and handed the person a Terminal script. Claude Desktop has a Connectors screen that takes the remote URL directly: one URL, no Node, no restart. Nothing on the page told the agent to prefer it, and the page is a reference for people, not a recipe for an agent.newsmcp.com solves this with a single
SKILL.mdand a one-line paste:Read and follow <url>. This PR gives the News API MCP the same.What
news-api/integrations/mcp-agent-setup, hidden:hidden: trueand nodocs.jsonentry, so it is served by URL (and as.md) but stays out of the sidebar, search, sitemap and llms.txt. The tip on the MCP page is the only link to it. Written for the agent: which path to take for the client it is running in (Claude.ai/Desktop first, mcp-remote last), a one-curl key check before touching config, the defaults that decide what comes back, failure meanings, recipes. Mintlify serves it as markdown at.../mcp-agent-setup.md, which is the URL the paste line uses.mcp-remote, where it comes from. A tip at the top carries the paste line. Authentication wording, two troubleshooting entries and See also updated.llms.txtandsitemap.xmlregenerated with the repo scripts (unchanged in the end, since the page is hidden).Verified
?apiToken=,x-api-token,Authorization: Bearer, tool argument) authenticate on the hosted server today: a bad token in each returns401 Invalid api key, notAPI token is required.tools/callPOST withoutinitializeworks, so the curl in Step 1 is real.python scripts/generate_llms_txt.py --checkpasses;mint broken-linkspasses.The platform side (copy button text) is a separate PR on newscatcher-insights and should merge after this one.
🤖 Generated with Claude Code