omnisearch-mcp 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +94 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
# omnisearch-mcp
|
|
2
|
+
|
|
3
|
+
> Model Context Protocol (MCP) server for multi-provider web search retrieval, powered by [`omnisearch-sdk`](https://www.npmjs.com/package/omnisearch-sdk).
|
|
4
|
+
|
|
5
|
+
Give Claude Desktop, Cursor, and MCP-compatible AI agent runtimes real-time search across 15+ search providers (Brave, Google, Bing, DuckDuckGo, Tavily, Perplexity, PubMed, Arxiv, GitHub, and more) with automatic fallback and canonical deduplication.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## ⚡ Quick Setup
|
|
10
|
+
|
|
11
|
+
### 1. Claude Desktop Setup
|
|
12
|
+
|
|
13
|
+
Add to your `claude_desktop_config.json`:
|
|
14
|
+
|
|
15
|
+
* **macOS:** `~/Library/Application Support/Claude/claude_desktop_config.json`
|
|
16
|
+
* **Windows:** `%APPDATA%\Claude\claude_desktop_config.json`
|
|
17
|
+
|
|
18
|
+
```json
|
|
19
|
+
{
|
|
20
|
+
"mcpServers": {
|
|
21
|
+
"omnisearch": {
|
|
22
|
+
"command": "npx",
|
|
23
|
+
"args": ["-y", "omnisearch-mcp"],
|
|
24
|
+
"env": {
|
|
25
|
+
"BRAVE_API_KEY": "YOUR_BRAVE_API_KEY",
|
|
26
|
+
"TAVILY_API_KEY": "YOUR_TAVILY_API_KEY"
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
}
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
> **Note:** If no API keys are provided in `env`, the server automatically defaults to zero-config public providers (DuckDuckGo, PubMed, Arxiv, Semantic Scholar).
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
### 2. Cursor IDE Setup
|
|
38
|
+
|
|
39
|
+
In Cursor Settings -> **Features** -> **MCP Servers** -> **Add New MCP Server**:
|
|
40
|
+
|
|
41
|
+
* **Name:** `omnisearch`
|
|
42
|
+
* **Type:** `command`
|
|
43
|
+
* **Command:** `npx -y omnisearch-mcp`
|
|
44
|
+
|
|
45
|
+
---
|
|
46
|
+
|
|
47
|
+
## 🛠 Available MCP Tools
|
|
48
|
+
|
|
49
|
+
The server automatically registers two tools:
|
|
50
|
+
|
|
51
|
+
### `web_search`
|
|
52
|
+
Search the live web across multiple engines with automatic multi-provider fallback, canonical deduplication, and domain filtering.
|
|
53
|
+
|
|
54
|
+
| Argument | Type | Description |
|
|
55
|
+
| :--- | :--- | :--- |
|
|
56
|
+
| `query` | `string` | The search query string (**required**). |
|
|
57
|
+
| `maxResults` | `number` | Maximum number of results to return (default: `10`). |
|
|
58
|
+
| `freshness` | `string` | Recency filter: `'day'`, `'week'`, `'month'`, `'year'`. |
|
|
59
|
+
| `includeDomains` | `string[]` | Whitelist specific domains (e.g. `["github.com", "arxiv.org"]`). |
|
|
60
|
+
| `excludeDomains` | `string[]` | Blacklist specific domains (e.g. `["pinterest.com"]`). |
|
|
61
|
+
| `deduplicate` | `boolean` | Enable intelligent canonical URL deduplication (default: `true`). |
|
|
62
|
+
|
|
63
|
+
### `news_search`
|
|
64
|
+
Search breaking news and recent journalistic coverage across supported news providers.
|
|
65
|
+
|
|
66
|
+
| Argument | Type | Description |
|
|
67
|
+
| :--- | :--- | :--- |
|
|
68
|
+
| `query` | `string` | The news query string (**required**). |
|
|
69
|
+
| `maxResults` | `number` | Maximum number of results to return (default: `10`). |
|
|
70
|
+
| `freshness` | `string` | Recency filter: `'day'`, `'week'`, `'month'` (default: `'week'`). |
|
|
71
|
+
|
|
72
|
+
---
|
|
73
|
+
|
|
74
|
+
## 🌐 Supported Provider Environment Variables
|
|
75
|
+
|
|
76
|
+
Configure any combination of API keys:
|
|
77
|
+
|
|
78
|
+
* `BRAVE_API_KEY` - Brave Search API
|
|
79
|
+
* `TAVILY_API_KEY` - Tavily Search API
|
|
80
|
+
* `GOOGLE_API_KEY` & `GOOGLE_CX` - Google Custom Search API
|
|
81
|
+
* `BING_API_KEY` - Azure Bing Search API
|
|
82
|
+
* `YOU_API_KEY` - You.com Search API
|
|
83
|
+
* `EXA_API_KEY` - Exa Neural Search API
|
|
84
|
+
* `PERPLEXITY_API_KEY` - Perplexity Search API
|
|
85
|
+
* `PARALLEL_API_KEY` - Parallel Search API
|
|
86
|
+
* `SERPAPI_API_KEY` - SerpAPI
|
|
87
|
+
* `SEARXNG_BASE_URL` - Self-hosted SearXNG endpoint
|
|
88
|
+
* `GITHUB_TOKEN` - GitHub API Token (optional, raises rate limits)
|
|
89
|
+
|
|
90
|
+
---
|
|
91
|
+
|
|
92
|
+
## 📄 License
|
|
93
|
+
|
|
94
|
+
MIT © [OmniSearch SDK Contributors](https://github.com/gbks121/omnisearch-sdk)
|