crayonlu / dsh-web-search-firecrawl

@crayonlu/dsh-web-search-firecrawl

Firecrawl-backed WebSearchProvider for the DeepSeek Harness web capability seam (ctx.web). Lets dsh's web_search tool run entirely on Firecrawl (v2 /search) — no DeepSeek API key required.

Install

dsh plugin --profile web add github:crayonlu/dsh-web-search-firecrawl

Then add the provider to the profile patch layer at $DSH_HOME/profiles/web/cordis.patch.yml (hot-reloaded — no restart needed):

- insert:
  - id: web-search-firecrawl
    name: '@crayonlu/dsh-web-search-firecrawl'
- id: web
  config:
    searchProvider: firecrawl
# Optional: drop the DeepSeek-backed search (and chat route) entirely.
- id: web-search-deepseek
  disabled: true
- id: llm-deepseek
  disabled: true

Configuration

Every field is optional:

Field	Default	Meaning
apiKey	—	Literal Firecrawl key (write it here instead of apiKeyEnv only if you must; it lands in a config file).
apiKeyEnv	FIRECRAWL_API_KEY	Credential reference resolved per search through ctx.credentials (inherited env > $DSH_HOME/.credentials.yaml > project/user .env).
baseURL	https://api.firecrawl.dev/v2	Firecrawl v2 endpoint base; /search is appended.
maxResults	5	Default result count when a request carries no maxResults.

The key resolves once per search, so an empty FIRECRAWL_API_KEY fails the request with WEB_MISSING_CREDENTIAL rather than falling through to an unrelated credential.

Tests

npm install
npm test

Unit tests mock the HTTP layer; the smoke test runs a real Firecrawl search when FIRECRAWL_API_KEY is set.

License

MIT