Skip to content

Commit f76c180

Browse files
docs: align NeuroAPI skills with v0.1.13
Correct streaming events, status codes, and client timeouts, and document system_prompt, output_schema, idempotency, quota headers, and MCP from the live NeuroAPI docs. Co-authored-by: Vlad Yashin <0xspacecreated@users.noreply.github.com>
1 parent 8991581 commit f76c180

8 files changed

Lines changed: 513 additions & 120 deletions

File tree

‎.claude-plugin/marketplace.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
"name": "neurobro-meme-hunting",
3232
"source": "./skills/neurobro-meme-hunting",
3333
"skills": "./",
34-
"description": "Discover and risk-vet trending and newly launched memecoins through the NeuroAPI agent - scan trending DEX pools, filter by liquidity and age, and audit tokens for honeypots, rug-pull risk, and holder concentration",
34+
"description": "Discover and risk-vet trending and newly launched memecoins through the NeuroAPI agent - screen tokens for scam flags, mint and freeze authority, holder concentration, and buy/sell pressure, and filter new launches by age and liquidity",
3535
"keywords": [
3636
"neurobro",
3737
"neuroapi",

‎README.md‎

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ and rate limits, and writing prompts that produce useful research.
2222
| Skill | What it does |
2323
| --- | --- |
2424
| [`neurobro-market-research`](skills/neurobro-market-research/) | Financial market research via the NeuroAPI agent - equity and crypto analysis, technical setups, fundamental research, macro outlooks, and multi-asset investigations. |
25-
| [`neurobro-meme-hunting`](skills/neurobro-meme-hunting/) | Discover and risk-vet trending and newly launched memecoins - scan trending DEX pools, filter by liquidity and age, audit for honeypots, rug-pull risk, and holder concentration. |
25+
| [`neurobro-meme-hunting`](skills/neurobro-meme-hunting/) | Discover and risk-vet trending and newly launched memecoins - screen for scam flags, mint and freeze authority, holder concentration, and buy/sell pressure, and filter new launches by age and liquidity. |
2626
| [`neurobro-trading-setup`](skills/neurobro-trading-setup/) | Build structured trade setups - entry zones, stop-loss, take-profit targets, and risk/reward ratios grounded in technical analysis and derivatives positioning. |
2727
| [`neurobro-catalyst-watch`](skills/neurobro-catalyst-watch/) | Build event-driven trade plans - map upcoming catalysts (earnings, FOMC and macro prints, token unlocks, launches, listings, regulatory decisions), assess what is priced in, and plan positioning around the event. |
2828

@@ -47,7 +47,8 @@ Or as a Claude Code plugin:
4747

4848
1. [Create an API key](https://neuroapi.neurobro.ai) in the NeuroAPI dashboard
4949
under **API Keys**. Keys look like `neuro_<random>` and are shown only once.
50-
2. Make sure the account has an active plan - `/agent/ask` requires one.
50+
2. Make sure the account has an active plan. No plan returns `403`
51+
`no_active_subscription` on `/agent/ask`.
5152
3. Provide the key via the `NEUROAPI_API_KEY` environment variable:
5253

5354
```bash
@@ -58,6 +59,14 @@ Or as a Claude Code plugin:
5859
`.env` is git-ignored, so the real key is never committed. `.env.example` is
5960
the committed template and holds no secret.
6061

62+
## MCP
63+
64+
The same agent is available over MCP at `https://api.neurobro.ai/api/v1/mcp`
65+
(Streamable HTTP), tool `ask_neuroapi`. Send `X-API-Key`.
66+
`Authorization: Bearer` is accepted on that endpoint only. The REST API
67+
does not accept it. Do not put the key in the URL. See
68+
[the endpoint reference](skills/neurobro-market-research/references/endpoints.md#mcp).
69+
6170
## Repo layout
6271

6372
```

‎agents/AGENTS.md‎

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,15 @@ paid public API for financial market research.
66
## What NeuroAPI is
77

88
- Base URL: `https://api.neurobro.ai/api/v1`
9-
- Auth: `X-API-Key` header. Keys look like `neuro_<random>`. No OAuth, no
10-
`Authorization: Bearer`.
9+
- Auth: REST calls use the `X-API-Key` header. Keys look like `neuro_<random>`.
10+
No OAuth. `Authorization: Bearer` is not accepted on the REST API. It is
11+
accepted only by the MCP server at `https://api.neurobro.ai/api/v1/mcp`
12+
(tool `ask_neuroapi`). Do not put the key in the URL.
1113
- Core endpoint: `POST /agent/ask` - runs a financial research agent over a
12-
natural-language `prompt` and returns an `answer`.
13-
- Free check: `GET /health` - verifies the key, consumes no quota.
14+
natural-language `prompt` and returns an `answer`. With `output_schema`,
15+
the object is on `output` and `answer` is null.
16+
- Free check: `GET /health` - verifies the key, consumes no quota. An active
17+
subscription is still required.
1418

1519
## API key
1620

@@ -27,8 +31,9 @@ relevant to the task:
2731
equity and crypto analysis, technical setups, fundamental research, macro
2832
outlooks, multi-asset investigations.
2933
- `neurobro-meme-hunting` - discover and risk-vet trending and newly launched
30-
memecoins: scan DEX pools, filter by liquidity and age, audit for honeypots,
31-
rug-pull risk, and holder concentration.
34+
memecoins: screen for scam flags, mint and freeze authority, holder
35+
concentration, and buy/sell pressure, and filter new launches by age and
36+
liquidity.
3237
- `neurobro-trading-setup` - build structured trade setups: entry zones,
3338
stop-loss, take-profit targets, and risk/reward ratios from technical
3439
analysis and derivatives positioning.

‎skills/neurobro-catalyst-watch/SKILL.md‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,10 @@ Every request goes to one endpoint:
4545

4646
Authenticate with the `X-API-Key` header, reading the key from the
4747
`NEUROAPI_API_KEY` environment variable - never hardcode it. The body takes a
48-
`prompt` and a `mode` (`fast` | `smart` | `max`, default `smart`).
48+
`prompt` and a `mode` (`fast` | `smart` | `max`, default `smart`). A
49+
non-streaming run longer than 300 seconds returns `504` `agent_timeout`
50+
and is not billed, so set the client timeout above 300 seconds and prefer
51+
`stream: true` for `max`.
4952

5053
```bash
5154
curl -s https://api.neurobro.ai/api/v1/agent/ask \
@@ -196,7 +199,7 @@ def ask(prompt: str, mode: str = "smart") -> str:
196199
"https://api.neurobro.ai/api/v1/agent/ask",
197200
headers={"X-API-Key": os.environ["NEUROAPI_API_KEY"]},
198201
json={"prompt": prompt, "mode": mode},
199-
timeout=90,
202+
timeout=330,
200203
)
201204
res.raise_for_status()
202205
return res.json()["answer"]
@@ -233,6 +236,7 @@ inside the trading window.
233236
the plan; it reasons over expectations, positioning, and history together.
234237
- `max` - a watchlist-wide calendar across many assets, or a high-stakes event
235238
(a major earnings print, an FOMC decision) where the deepest reasoning pays.
239+
Stream it (`stream: true`); a non-streaming run is stopped at 300 seconds.
236240
- `fast` - only for a quick "what events are coming" lookup with no analysis.
237241

238242
## Risk notes

0 commit comments

Comments
 (0)