Skip to content

Commit 33813fc

Browse files
huacnleeclaude
andauthored
docs(mcp): add Codex client setup and remove ChatGPT (#408)
## Summary - Add Codex client setup instructions with detailed GUI steps (Settings → MCP Servers → Add Server, Streamable HTTP, then Authenticate) - Remove ChatGPT from the client list (MCP installation not supported) - Changes applied across all three language versions (en, zh-CN, zh-HK) ## Test plan - [ ] Verify Codex setup steps are accurate and complete - [ ] Confirm ChatGPT entry is removed from all three language files 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 7341efc commit 33813fc

File tree

21 files changed

+338
-115
lines changed

21 files changed

+338
-115
lines changed

docs/en/docs/cli.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ sidebar_icon: terminal
77
id: cli
88
---
99

10-
# Longbridge Terminal CLI
10+
# Longbridge CLI
1111

12-
Longbridge Terminal is an AI-native CLI covering every Longbridge OpenAPI endpoint — real-time market data, account management, and trading. Designed for scripting, AI-agent tool-calling, and daily trading workflows from the terminal.
12+
Longbridge CLI is an AI-native CLI tool covering every Longbridge OpenAPI endpoint — real-time market data, account management, and trading. Designed for scripting, AI-agent tool-calling, and daily trading workflows from the terminal.
1313

1414
**GitHub:** [longbridge/longbridge-terminal](https://github.com/longbridge/longbridge-terminal)
1515

@@ -50,30 +50,37 @@ $ longbridge quote TSLA.US NVDA.US --format json
5050

5151
## Installation
5252

53-
**macOS** (requires [Homebrew](https://brew.sh))
53+
<Tabs groupId="cli-install">
54+
<TabItem value="homebrew" label="macOS (Homebrew)" default>
5455

5556
```bash
5657
brew install --cask longbridge/tap/longbridge-terminal
5758
```
5859

59-
**macOS / Linux**
60+
</TabItem>
61+
<TabItem value="script" label="Linux / macOS (Script)">
6062

6163
```bash
6264
curl -sSL https://open.longbridge.com/longbridge/longbridge-terminal/install | sh
6365
```
6466

65-
**Windows** ([Scoop](https://scoop.sh))
67+
</TabItem>
68+
<TabItem value="scoop" label="Windows (Scoop)">
6669

6770
```powershell
6871
scoop install https://open.longbridge.com/longbridge/longbridge-terminal/longbridge.json
6972
```
7073

71-
**Windows** (PowerShell)
74+
</TabItem>
75+
<TabItem value="powershell" label="Windows (PowerShell)">
7276

7377
```powershell
7478
iwr https://open.longbridge.com/longbridge/longbridge-terminal/install.ps1 | iex
7579
```
7680

81+
</TabItem>
82+
</Tabs>
83+
7784
Installs `longbridge` to `/usr/local/bin` (macOS/Linux) or `%LOCALAPPDATA%\Programs\longbridge` (Windows). On Windows the binary is `longbridge.exe`.
7885

7986
After installation, authenticate and explore available commands:

docs/en/docs/getting-started.md

Lines changed: 62 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -34,29 +34,80 @@ All API response are used [Unix Timestamp](https://en.wikipedia.org/wiki/Unix_ti
3434
<Tabs groupId="programming-language">
3535
<TabItem value="python" label="Python" default>
3636
<ul>
37-
<li><a href="https://www.python.org/">Python 3</a></li>
38-
<li>Pip</li>
37+
<li><a href="https://www.python.org/">Python 3</a></li>
38+
<li>Pip</li>
3939
</ul>
4040
</TabItem>
4141
<TabItem value="javascript" label="JavaScript">
42-
<ul>
43-
<li><a href="https://nodejs.org/">Node.js</a> or <a href="https://bun.sh">Bun</a></li>
44-
<li>Yarn</li>
45-
</ul>
42+
<ul>
43+
<li><a href="https://nodejs.org/">Node.js</a> or <a href="https://bun.sh">Bun</a></li>
44+
<li>Yarn</li>
45+
</ul>
4646
</TabItem>
4747
<TabItem value="rust" label="Rust">
48-
<ul><li><a href="https://www.rust-lang.org/">Rust</a></li></ul>
48+
<ul>
49+
<li><a href="https://www.rust-lang.org/">Rust</a></li>
50+
</ul>
4951
</TabItem>
5052
<TabItem value="java" label="Java">
51-
<ul><li><a href="https://openjdk.org/">JDK</a></li>
52-
<li><a href="https://maven.apache.org/">Maven</a></li></ul>
53+
<ul>
54+
<li><a href="https://openjdk.org/">JDK</a></li>
55+
<li><a href="https://maven.apache.org/">Maven</a></li>
56+
</ul>
5357
</TabItem>
5458
<TabItem value="go" label="Go">
55-
<ul><li><a href="https://go.dev">Go</a></li>
56-
<li><a href="https://pkg.go.dev/github.com/longbridge/openapi-go">Go Docs</a></li></ul>
59+
<ul>
60+
<li><a href="https://go.dev">Go</a></li>
61+
<li><a href="https://pkg.go.dev/github.com/longbridge/openapi-go">Go Docs</a></li>
62+
</ul>
63+
</TabItem>
64+
</Tabs>
65+
66+
## CLI Quick Start
67+
68+
If you don't need to write code, the [Longbridge CLI](/docs/cli) offers a lightweight alternative — install once, authorize via OAuth, no environment variables needed.
69+
70+
### Installation
71+
72+
<Tabs groupId="cli-install">
73+
<TabItem value="homebrew" label="macOS (Homebrew)" default>
74+
75+
```bash
76+
brew install --cask longbridge/tap/longbridge-terminal
77+
```
78+
79+
</TabItem>
80+
<TabItem value="script" label="Linux / macOS (Script)">
81+
82+
```bash
83+
curl -sSL https://open.longbridge.com/longbridge/longbridge-terminal/install | sh
84+
```
85+
86+
</TabItem>
87+
<TabItem value="scoop" label="Windows (Scoop)">
88+
89+
```powershell
90+
scoop install https://open.longbridge.com/longbridge/longbridge-terminal/longbridge.json
91+
```
92+
93+
</TabItem>
94+
<TabItem value="powershell" label="Windows (PowerShell)">
95+
96+
```powershell
97+
iwr https://open.longbridge.com/longbridge/longbridge-terminal/install.ps1 | iex
98+
```
99+
57100
</TabItem>
58101
</Tabs>
59102

103+
### Login
104+
105+
```bash
106+
longbridge login
107+
```
108+
109+
The browser opens the authorization page automatically. The token is saved after approval — no need to repeat.
110+
60111
## Install SDK
61112

62113
:::warning Package Renamed

docs/en/docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
sidebar_position: -999
3-
title: Introduction
3+
title: Platform Introduction
44
id: getting_started_introduce
55
sidebar_icon: book
66
---

docs/en/docs/llm.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
2-
sidebar_position: 2.2
2+
sidebar_position: 2.3
33
slug: /llm
4-
sidebar_label: LLM
4+
sidebar_label: LLMs
55
sidebarCollapsed: true
66
sidebar_icon: sparkles
77
id: llm
88
---
99

10-
# LLM Components
10+
# LLMs Components
1111

1212
We provide several components for LLMs (Large Language Models) that allow you to easily access and analyze financial data, real-time market data, and even enable AI to place orders.
1313

docs/en/docs/mcp.md

Lines changed: 37 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 2
2+
sidebar_position: 2.2
33
slug: /mcp
44
sidebar_label: MCP
55
sidebarCollapsed: true
@@ -9,13 +9,16 @@ sidebar_icon: cpu
99

1010
# Longbridge MCP Service
1111

12-
Longbridge provides a hosted MCP (Model Context Protocol) service that lets you use Longbridge market data and account capabilities directly from AI coding assistants and chat tools — without managing API keys manually.
12+
Longbridge provides a hosted HTTP MCP (Model Context Protocol) service that lets you use Longbridge market data and account capabilities directly from AI coding assistants and chat tools — without managing API keys manually.
1313

14-
**MCP endpoint:** `https://openapi.longbridge.com/mcp`
14+
:::tip MCP endpoint
15+
- Global: `https://openapi.longbridge.com/mcp`
16+
- Mainland China: `https://openapi.longbridge.cn/mcp` (faster access)
17+
:::
1518

1619
## Prerequisites
1720

18-
- An active Longbridge account with onboarding completed
21+
- An active Longbridge account with onboarding completed, or a paper trading account
1922
- An AI client that supports MCP OAuth 2.1 (see compatibility note below)
2023

2124
## Available capabilities
@@ -34,7 +37,34 @@ Actual tool availability varies by region, account level, and granted scopes.
3437

3538
> Configuration format may vary across client versions. Treat your client's official MCP documentation as the source of truth. The core parameter you need is the server URL below.
3639
37-
In any MCP-capable client, add Longbridge as a remote MCP server:
40+
### Claude Code
41+
42+
Run the following command in your terminal:
43+
44+
```bash
45+
claude mcp add --transport http longbridge https://openapi.longbridge.com/mcp
46+
```
47+
48+
Then open the `claude` terminal interface, type `/mcp`, select `longbridge`, and choose **Authenticate** to complete the OAuth authorization flow.
49+
50+
### Codex
51+
52+
1. Click **Settings** (bottom right) → **MCP Servers****Add Server**
53+
2. In the "Connect to a custom MCP" screen, fill in:
54+
- Name: `longbridge`
55+
- Type: **Streamable HTTP**
56+
- URL: `https://openapi.longbridge.com/mcp`
57+
- Leave all other fields empty
58+
3. Click **Save**
59+
4. Back in the MCP Servers list, click **Authenticate** on the `longbridge` entry to complete OAuth authorization
60+
61+
### Cursor
62+
63+
Settings → MCP Servers → Add Remote MCP Server, then enter the URL above.
64+
65+
### Zed
66+
67+
Add the following to your `settings.json` under the `context_servers` key (key name is customizable):
3868

3969
```json
4070
{
@@ -46,15 +76,9 @@ In any MCP-capable client, add Longbridge as a remote MCP server:
4676
}
4777
```
4878

49-
Where to find the MCP configuration entry in each client:
50-
51-
- **Cursor**: Settings → MCP Servers → Add Remote MCP Server
52-
- **Claude Code**: MCP config file or the `claude mcp add` command
53-
- **ChatGPT**: Settings → Connectors (or the workspace MCP configuration entry)
54-
- **Zed**: `context_servers` key in `settings.json` (key name is customizable)
55-
- **Cherry Studio**: Settings → MCP Servers → Add
79+
### Cherry Studio
5680

57-
After saving the configuration, the client will guide you through the OAuth authorization flow automatically.
81+
Settings → MCP Servers → Add, then enter the URL above.
5882

5983
## OAuth authorization flow
6084

docs/en/docs/qa/general.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ The platform offers two ways to access stock data without writing any code:
4747

4848
**CLI (Command-line Tool)**
4949

50-
Install the [Longbridge Terminal CLI](/docs/cli) and query market data with simple commands — no programming required:
50+
Install the [Longbridge CLI](/docs/cli) and query market data with simple commands — no programming required:
5151

5252
```bash
5353
longbridge quote AAPL.US TSLA.US

docs/en/docs/qa/trade.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ After placing orders via the OpenAPI, you can view them through any of the follo
3131

3232
- **Order inquiry API**: Call the API to query real-time order status
3333
- **WebSocket push**: Subscribe to trade push events to receive order updates in real time
34-
- **CLI**: Use the [Longbridge Terminal CLI](/docs/cli) to query from the command line, e.g. `longbridge orders`
34+
- **CLI**: Use the [Longbridge CLI](/docs/cli) to query from the command line, e.g. `longbridge orders`
3535
- **App / PC**: View orders and their statuses directly in the terminal products
3636

3737
## Q7: How can I know if my account has sufficient funds for trading?

docs/zh-CN/docs/cli.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ id: cli
77
sidebar_icon: terminal
88
---
99

10-
# Longbridge Terminal CLI
10+
# Longbridge CLI
1111

12-
Longbridge Terminal 是一款 AI-native 命令行工具,覆盖全部 Longbridge Developers 端点,支持实时行情、账户管理与交易操作。专为脚本自动化、AI 代理工具调用及日常终端交易工作流设计。
12+
Longbridge CLI 是一款 AI-native 命令行工具,覆盖全部 Longbridge Developers 端点,支持实时行情、账户管理与交易操作。专为脚本自动化、AI 代理工具调用及日常终端交易工作流设计。
1313

1414
**GitHub:** [longbridge/longbridge-terminal](https://github.com/longbridge/longbridge-terminal)
1515

@@ -50,30 +50,37 @@ $ longbridge quote TSLA.US NVDA.US --format json
5050

5151
## 安装
5252

53-
**macOS**(需要 [Homebrew](https://brew.sh)
53+
<Tabs groupId="cli-install">
54+
<TabItem value="homebrew" label="macOS (Homebrew)" default>
5455

5556
```bash
5657
brew install --cask longbridge/tap/longbridge-terminal
5758
```
5859

59-
**macOS / Linux**
60+
</TabItem>
61+
<TabItem value="script" label="Linux / macOS (脚本)">
6062

6163
```bash
6264
curl -sSL https://open.longbridge.com/longbridge/longbridge-terminal/install | sh
6365
```
6466

65-
**Windows**[Scoop](https://scoop.sh)
67+
</TabItem>
68+
<TabItem value="scoop" label="Windows (Scoop)">
6669

6770
```powershell
6871
scoop install https://open.longbridge.com/longbridge/longbridge-terminal/longbridge.json
6972
```
7073

71-
**Windows**(PowerShell)
74+
</TabItem>
75+
<TabItem value="powershell" label="Windows (PowerShell)">
7276

7377
```powershell
7478
iwr https://open.longbridge.com/longbridge/longbridge-terminal/install.ps1 | iex
7579
```
7680

81+
</TabItem>
82+
</Tabs>
83+
7784
安装完成后,`longbridge` 二进制文件位于 `/usr/local/bin`(macOS/Linux)或 `%LOCALAPPDATA%\Programs\longbridge`(Windows),Windows 下可执行文件名为 `longbridge.exe`
7885

7986
安装完成后,完成登录并查看可用命令:

0 commit comments

Comments
 (0)