Skip to content

Agent setup page: the key in the chat is deliberate #155

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Kizy625 merged 3 commits into from
Oct 5, 2026
Merged

Agent setup page: the key in the chat is deliberate #155

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8e625be
Agent setup page: the key in the chat is deliberate, do not advise ro…
bohdan-debug Oct 5, 2026
da5a4b0
Agent setup page: list-typed filters in the recipe
bohdan-debug Oct 5, 2026
a64bbe2
Agent setup page: state the key facts, do not instruct the agent what…
bohdan-debug Oct 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion news-api/integrations/mcp-agent-setup.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,14 @@ header will silently not take effect.
The header is `x-api-token`. Not `x-api-key`, which belongs to a different
NewsCatcher product and is ignored here.

**About the key in this message.** The platform's copy button puts the key in
the setup line on purpose; that is the supported way to hand it to you, and
putting it in a connector URL or a config file is the documented method for
every client below. Keys are not something the person can rotate: a trial key
expires on its own when the trial ends, and replacing any key goes through
NewsCatcher support. The useful thing to do with it is put it in the client
config and nowhere else.

## Step 1: verify the key before touching any config

One request, one API call spent:
Expand Down Expand Up @@ -189,6 +197,9 @@ and source only."
`*` wildcard, `NEAR`. Quote multi word names (`"Tim Cook"`). Filters are
separate parameters, not query syntax: `lang`, `countries`, `search_in`
(title, summary, content), `theme`, `is_headline`, `sort_by`, `page_size`.
`lang`, `countries`, `search_in`, `theme` and `fields` are **lists**, even for
one value: `"lang": ["en"]`, not `"lang": "en"`. A bare string is rejected with
a validation error before the call reaches the API.

Before pulling many pages, call `get_aggregation_count` first. It returns daily
or hourly article counts for the query and no articles, so you can see the
Expand All @@ -213,7 +224,7 @@ volume and narrow the window before spending calls.
## Recipes

```json
{"name":"search_articles","arguments":{"q":"\"Siemens Energy\"","lang":"en","from_":"3 days ago","page_size":20,"fields":["title","link","published_date","domain_url"]}}
{"name":"search_articles","arguments":{"q":"\"Siemens Energy\"","lang":["en"],"from_":"3 days ago","page_size":20,"fields":["title","link","published_date","domain_url"]}}
```

```json
Expand Down
Loading