opencode-elm-websearch
v0.2.0
Published
An OpenCode plugin that searches the public web through the University of Edinburgh ELM API.
Readme
OpenCode ELM web search
An OpenCode plugin that adds an elm-websearch tool backed by the University of Edinburgh ELM search API.
The tool supports fast, standard, and deep search, domain and date filters, and returns source URLs and content for citation-backed answers.
Requirements
- OpenCode V2 with npm plugin support
- An ELM API key with access to web search
Install
Add the plugin to your global ~/.config/opencode/opencode.jsonc or a project opencode.jsonc:
{
"$schema": "https://opencode.ai/config.json",
"plugins": ["opencode-elm-websearch"]
}OpenCode installs npm plugins automatically when it starts.
The plugin registers its bundled elm-websearch skill automatically. The skill is active only while the plugin is enabled; no separate skill installation is required.
Set the API key in the environment used to launch OpenCode:
export ELM_API_KEY="your-key"
opencodeDo not commit the key to a repository. The base URL defaults to https://elm.edina.ac.uk/api/v1. For development or another ELM deployment, set ELM_API_BASE_URL before starting OpenCode.
Tool arguments
| Argument | Required | Description |
| --- | --- | --- |
| query | Yes | Focused web-search query |
| depth | No | fast, standard (default), or deep |
| max_results | No | Number of results, from 1 to 100; defaults to 10 |
| include_domains | No | Domains to include |
| exclude_domains | No | Domains to exclude |
| from_date | No | Earliest result date in YYYY-MM-DD format |
| to_date | No | Latest result date in YYYY-MM-DD format |
fast is best for short keyword-style lookups, standard for normal searches, and deep for complex multi-step research.
Development
npm install
npm testTo test the unpublished plugin from a checkout, add its absolute directory to the plugins array in opencode.jsonc, then restart OpenCode.
Publishing
Review the package contents before publishing:
npm pack --dry-run
npm publishReleases follow semantic versioning.
License
MIT
