Tools
Youcom
By You.com web search and page content extraction plugin for OpenClaw (web_search provider + you_search + you_contents)
Install
npm install
npmConfiguration Example
# Option B: OpenClaw config (plugins.entries.youcom.config)
plugins:
entries:
youcom:
enabled: true
config:
webSearch:
apiKey: "your-key" # or a SecretRef object
# baseUrl: "https://api.you.com" # optional overrideREADME
# You.com OpenClaw Plugin
[You.com](https://you.com) web search and page content extraction as an
[OpenClaw](https://github.com/openclaw/openclaw) plugin.
Registers a **`you` web search provider** (powers the generic `web_search` tool
when selected) plus two You.com-specific tools:
| Tool | What it does |
| ------------- | ------------------------------------------------------------------------------ |
| `web_search` | Generic search via the provider contract, when You.com is the selected provider |
| `you_search` | You.com search with freshness windows and extraction modes |
| `you_contents`| Page content extraction from URLs (markdown / HTML / metadata) |
## Install
```sh
openclaw plugins install openclaw-youcom-plugin
```
Or from ClawHub once published there:
```sh
openclaw plugins install clawhub:openclaw-youcom-plugin
```
## Configure
You.com participates in web-search auto-detection only after a key is
configured (it will not shadow keyless fallbacks like DuckDuckGo):
```sh
# Option A: environment variable in the Gateway environment
export YDC_API_KEY="your-key"
```
```yaml
# Option B: OpenClaw config (plugins.entries.youcom.config)
plugins:
entries:
youcom:
enabled: true
config:
webSearch:
apiKey: "your-key" # or a SecretRef object
# baseUrl: "https://api.you.com" # optional override
```
Get an API key at [you.com/platform](https://you.com/platform). Then select the
provider:
```sh
openclaw config set tools.web.search.provider you
```
## Tools
### `you_search`
| Parameter | Description |
| ------------ | ------------------------------------------------------------------------------------------------------- |
| `query` | Short natural-language phrase. Inline `site:`, `lang:`, `loc:` filters are mapped automatically. |
| `count` | Results to return (1-20). |
| `freshness` | Recency window: `day`, `week`, `month`, `year`, or `YYYY-MM-DDtoYYYY-MM-DD`. Omit for evergreen facts. |
| `extraction` | `highlights` (default) query-relevant passages; `none` plain snippets; `full_page` full page content. |
### `you_contents`
| Parameter | Description |
| --------------- | ---------------------------------------------------------------- |
| `urls` | Public http(s) URLs to extract (1-20). |
| `formats` | `markdown` (text), `html` (layout), `metadata` (structured data).|
| `crawl_timeout` | Per-page crawl timeout in seconds (1-60). |
| `max_age` | Max cached-content age in seconds; older pages are re-fetched. |
## How it works
The plugin calls the You.com MCP endpoint (`https://api.you.com/mcp`) with
JSON-RPC over HTTP, following the same conventions as the bundled OpenClaw
search providers:
- results are cached with the host's shared web-search cache TTL settings
- external content is wrapped through OpenClaw's external-content security
layer (`wrapWebContent`), with titles/snippets using the lightweight
`web_search` source and fetched page bodies the `web_fetch` source
- error messages surfaced to the agent are generic — HTTP status or
server-provided text only; keys and stack traces never reach the LLM
- `requiresCredential` defaults to true, so auto-detection only picks You.com
once a key exists (maintainer-review convention from openclaw#60519)
## Zero-signup alternative
You.com also offers a keyless MCP free profile (100 queries/day). For
occasional use without an API key you can connect the MCP server directly:
```sh
openclaw mcp add youcom https://api.you.com/mcp?profile=free
```
The plugin itself targets the keyed endpoint, which unlocks higher limits plus
the `you-contents` extraction tool.
## Roadmap
- `you_research` tool (deep research with citations) — pending verification
against a live API key; the tool exists on some You.com API tiers.
## Development
```sh
npm install
npm test # vitest unit tests
npm run plugin:inspect # @openclaw/plugin-inspector compatibility check
```
## License
MIT
tools
Comments
Sign in to leave a comment