0xrsydn/idx-cli
1
mirror of https://github.com/0xrsydn/idx-cli.git synced 2026-11-07 09:45:36 +00:00
Code Issues Projects Releases 1 Packages Wiki Activity

fix(web): address PR review (clean .md output, one MCP config source)

Browse source 
- .md output rewrites MDX-only syntax (Tabs, TabItem, asides, the MCP
  client component) into plain Markdown.
- MCP client setups live in one data file used by the landing page, the
  setup page and agents/install; the smoke-test claim names the five
  agents agent-smoke.sh actually drives (not Cursor).
- The landing page reads the version from Cargo.toml; the hand-copied BBCA
  data stays dated, and the design doc no longer promises capture.sh.
- MCP overview counts 11 tools plus the opt-in ownership_sync.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
hermes 2026-10-15 05:29:02 +00:00
commit 3623c50953
8 changed files with 101 additions and 121 deletions
Download patch file Download diff file Expand all files Collapse all files

22
web/src/content/docs/agents/install.md → web/src/content/docs/agents/install.mdx
View file

@ -3,6 +3,8 @@ title: Agent-led install
description: Instructions for a coding agent to install idx and register idx-mcp with itself.
---
import McpClientTabs from '../../../components/McpClientTabs.astro';
This page is written for a coding agent. A user sent you here to install
**idx** (a CLI for Indonesian stock market and KSEI ownership data) and
register its MCP server, **idx-mcp**, with the agent harness you are running
@ -44,22 +46,14 @@ Confirm with `idx version` (or `npx -y idx-cli version`).
## 3. Register idx-mcp with yourself
Work out which harness you are, then apply its setup. Use `npx` and
`["-y", "idx-mcp"]` as command and arguments, or `idx-mcp` with no arguments
if you installed the binary.
Work out which harness you are, then apply its setup below. If you installed
the `idx-mcp` binary instead of using Node.js, use the command `idx-mcp` with
no arguments in place of `npx -y idx-mcp`. For any other harness, find how it
registers a stdio MCP server, and ask the user if unsure.
| Harness | How |
| --- | --- |
| Claude Code | run `claude mcp add idx -- npx -y idx-mcp` |
| Codex | add to `~/.codex/config.toml`: `[mcp_servers.idx]` with `command = "npx"`, `args = ["-y", "idx-mcp"]` |
| Cursor | add to `~/.cursor/mcp.json` under `mcpServers`: `"idx": {"command": "npx", "args": ["-y", "idx-mcp"]}` |
| opencode | add to `~/.config/opencode/opencode.json` under `mcp`: `"idx": {"type": "local", "command": ["npx", "-y", "idx-mcp"], "enabled": true}` |
| pi | add to `~/.pi/agent/mcp.json` under `mcpServers`: `"idx": {"command": "npx", "args": ["-y", "idx-mcp"], "exposure": "direct"}` |
| Hermes | add to `~/.hermes/config.yaml` under `mcp_servers`: `idx` with `command: npx`, `args: ["-y", "idx-mcp"]`, `enabled: true` |
| anything else | find how your harness registers a stdio MCP server, and ask the user if unsure |
<McpClientTabs />
Merge into existing files; never overwrite other servers or settings. Full
examples: [MCP setup](/mcp/setup/).
Merge into existing files; never overwrite other servers or settings.
## 4. Download ownership data

2
web/src/content/docs/mcp/index.md
View file

@ -5,7 +5,7 @@ description: idx-mcp serves idx's stock and ownership data to AI agents over MCP
`idx-mcp` is a [Model Context Protocol](https://modelcontextprotocol.io)
server over stdio. It gives an agent the same data as the `idx` CLI, as
[11 tools](/mcp/tools/): quotes, price history, screening, company data,
[11 tools](/mcp/tools/) (plus an opt-in `ownership_sync`): quotes, price history, screening, company data,
analysis, comparison, and the KSEI ownership queries.
It shares idx's [config, cache and ownership database](/start/config/#files-idx-keeps),

89
web/src/content/docs/mcp/setup.mdx
View file

@ -5,7 +5,7 @@ sidebar:
label: Setup
---
import { Tabs, TabItem } from '@astrojs/starlight/components';
import McpClientTabs from '../../../components/McpClientTabs.astro';
:::tip[Quickest: let your agent do it]
Paste this into your coding agent. It follows
@ -33,91 +33,10 @@ nix profile install github:0xrsydn/idx-cli#idx-mcp
## 2. Add it to your client
<Tabs syncKey="agent">
<TabItem label="Claude Code">
<McpClientTabs />
```bash
claude mcp add idx -- npx -y idx-mcp
```
</TabItem>
<TabItem label="Codex">
`~/.codex/config.toml`:
```toml
[mcp_servers.idx]
command = "npx"
args = ["-y", "idx-mcp"]
```
</TabItem>
<TabItem label="Cursor">
`~/.cursor/mcp.json` (or `.cursor/mcp.json` in a project):
```json
{
"mcpServers": {
"idx": { "command": "npx", "args": ["-y", "idx-mcp"] }
}
}
```
</TabItem>
<TabItem label="opencode">
`opencode.json` in a project, or `~/.config/opencode/opencode.json`:
```json
{
"$schema": "https://opencode.ai/config.json",
"mcp": {
"idx": { "type": "local", "command": ["npx", "-y", "idx-mcp"], "enabled": true }
}
}
```
</TabItem>
<TabItem label="pi">
`~/.pi/agent/mcp.json`:
```json
{
"mcpServers": {
"idx": { "command": "npx", "args": ["-y", "idx-mcp"], "exposure": "direct" }
}
}
```
`"exposure": "direct"` gives the agent each tool by name.
</TabItem>
<TabItem label="Hermes">
`~/.hermes/config.yaml`:
```yaml
mcp_servers:
idx:
command: npx
args: ["-y", "idx-mcp"]
enabled: true
```
</TabItem>
<TabItem label="Other">
Any MCP client that runs stdio servers: command `npx`, arguments
`-y idx-mcp` (or the command `idx-mcp` if installed). Add `--allow-sync` to
the arguments to expose `ownership_sync`.
</TabItem>
</Tabs>
These are the setups that `tests/agents/agent-smoke.sh` drives with real
agents.
The Claude Code, Codex, opencode, pi and Hermes setups are the ones
`tests/agents/agent-smoke.sh` drives with the real agents.
## 3. Get ownership data