Server Configuration
Describes the environment variables required to run the server.
Name | Required | Description | Default |
---|---|---|---|
REF_ALPHA | No | Alpha configuration - still supported for former alpha users | |
REF_API_KEY | Yes | API key for Ref Tools - sign up to get an API key | |
DISABLE_SEARCH_WEB | No | Set to 'true' to disable the ref_search_web tool |
Schema
Prompts
Interactive templates invoked by user choice
Name | Description |
---|---|
search_docs | A quick way to check technical documentation. This prompt helps you search documentation for any technical platform, framework, API, service, database, or library. |
my_docs | Search through your private documentation, repos, and PDFs that you've uploaded to Ref. |
Resources
Contextual data attached and managed by the client
Name | Description |
---|---|
No resources |
Tools
Functions exposed to the LLM to take actions
Name | Description |
---|---|
ref_search_documentation | Search for documentation on the web or github as well from private resources like repos and pdfs. Use Ref 'ref_read_url' to read the content of a url. |
ref_read_url | Read the content of a url as markdown. The entire exact URL from a Ref 'ref_search_documentation' result should be passed to this tool to read it. |