Skip to content

docs(search): document the 10-result cap on mmx search query (#107) #170

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

Open
TumCucTom wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(search): document the 10-result cap on mmx search query (#107) #170

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,8 @@ mmx search "MiniMax AI"
mmx search query --q "latest news" --output json
```

> The `/v1/coding_plan/search` API returns at most 10 results per call and does not currently expose a pagination parameter (see #107). Refine your query if you need different results.

### `mmx auth`

```bash
Expand Down
2 changes: 2 additions & 0 deletions README_CN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,8 @@ mmx search "MiniMax AI"
mmx search query --q "最新动态" --output json
```

> `/v1/coding_plan/search` 接口单次最多返回 10 条结果，目前不支持翻页参数（参见 #107）。如需不同结果，请调整查询关键词。

### `mmx auth`

```bash
Expand Down
2 changes: 2 additions & 0 deletions SDK.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,8 @@ for (const item of results.organic) {
}
```

> The underlying `/v1/coding_plan/search` API returns at most 10 results per call and does not currently expose a pagination parameter (see #107). Refine your query if you need different results.

### Quota

```typescript
Expand Down
6 changes: 5 additions & 1 deletion src/commands/search/query.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,11 @@ interface SearchResponse {

export default defineCommand({
name: 'search query',
description: 'Search the web via MiniMax',
description:
'Search the web via MiniMax. ' +
'Note: the underlying /v1/coding_plan/search API returns at most 10 ' +
'results per call and does not currently support pagination, so ' +
'refining your --q is the only way to see different results.',
usage: 'mmx search query --q <query>',
options: [
{ flag: '--q <query>', description: 'Search query string' },
Expand Down