scree
by jrapakko
Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| SCREE_DB | No | Path to the SQLite index file. Defaults to `$XDG_DATA_HOME/scree/indexes/<folder>-<hash>/index.db`, one per folder (or `-db`). | |
| SCREE_ZDR | No | Set `0` for endpoints other than OpenRouter. When `1`, embedding requests are routed only to zero-data-retention endpoints. | 1 |
| SCREE_IMAGE | No | Container image used by `scree mcp -docker`. | scree:latest |
| SCREE_MODEL | No | Embedding model used for indexing. Changing the model requires `scree reindex -all`. | openai/text-embedding-3-small |
| SCREE_PAGER | No | The pager for `scree search`'s text view on a terminal: an absolute path or a name in `/usr/local/bin`, `/usr/bin` or `/bin` (never looked up on `PATH`), then its arguments. Set it empty for none. | less -FRX |
| SCREE_COLORS | No | The text view's colours as SGR codes (digits and `;` only) for word headings, matched words, locations and line numbers. `match=` turns one off. | word=1:match=1;33:link=36:lineno=2 |
| SCREE_DOCKER | No | Container engine for `scree mcp -docker` (`docker` or `podman` only, found in standard folders, never through `PATH`). | |
| SCREE_EMBED_URL | No | URL of the embedding API endpoint. | https://openrouter.ai/api/v1/embeddings |
| SCREE_DIMENSIONS | No | Embedding vector dimensions; `0` uses the model's default size. Changing this requires `scree reindex -all`. | 512 |
| SCREE_HTTP_TOKEN | No | Required with `serve -allow-remote` (at least 16 characters); enforced on loopback if set. Requests must send `Authorization: Bearer <token>`. | |
| SCREE_MOUNT_OPTS | No | Mount options used by `scree mcp -docker`; accepts only `ro`, `ro,z` or `ro,Z`. On SELinux hosts set it to `ro,z`. | ro |
| SCREE_DATA_VOLUME | No | Volume name (not a path) used by `scree mcp -docker` for the indexes. | |
| OPENROUTER_API_KEY | No | OpenRouter API key. When unset and the settings file holds one, commands run as `scree run` would. Without a key, notes are indexed for keyword search only and `auto` search runs `keyword`. | |
| SCREE_FIRST_SYNC_MB | No | A Claude Code session or `watch` won't start the first index of a folder with more markdown than this many MB (`0` = no limit); `scree reindex` always does. | 50 |
| SCREE_MAX_FILE_BYTES | No | Files larger than this many bytes are skipped. | 1048576 |
Instructions
Guidance the server publishes about itself, which clients place ahead of the tool catalog so the model reads it before choosing anything.
This server publishes no instructions, or was last inspected before Glama recorded them.
Capabilities
Server capabilities have not been inspected yet.
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
No tools | |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |
This server cannot be deployed
Maintenance
ActivityMaintained
ResponsivenessNo issues