Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| HOST | No | Host address for HTTP transport | 0.0.0.0 |
| PORT | No | Port number for HTTP transport | 8000 |
| AUTH_TYPE | No | Authentication type: 'none', 'static', 'jwt', 'oauth-proxy', 'oidc-proxy', 'remote-oauth' | none |
| TRANSPORT | No | Transport method: 'stdio', 'http', or 'sse' | stdio |
| EUNOMIA_TYPE | No | Eunomia authorization type: 'none', 'embedded', 'remote' | none |
| TOKEN_ISSUER | No | Issuer for JWT verification | |
| OIDC_BASE_URL | No | Base URL for OIDC Proxy | |
| ARCHIVEBOX_URL | No | URL of the ArchiveBox instance | |
| OAUTH_BASE_URL | No | Base URL for OAuth Proxy | |
| OIDC_CLIENT_ID | No | OIDC client ID | |
| TOKEN_AUDIENCE | No | Audience for JWT verification | |
| TOKEN_JWKS_URI | No | JWKS URI for JWT verification | |
| OIDC_CONFIG_URL | No | OIDC configuration URL | |
| REMOTE_BASE_URL | No | Base URL for Remote OAuth | |
| ARCHIVEBOX_TOKEN | No | Token for token authentication | |
| ARCHIVEBOX_VERIFY | No | Whether to verify SSL certificates | True |
| ARCHIVEBOX_API_KEY | No | API key for API key authentication | |
| EUNOMIA_REMOTE_URL | No | URL for remote Eunomia server | |
| OIDC_CLIENT_SECRET | No | OIDC client secret | |
| ARCHIVEBOX_PASSWORD | No | Password for basic authentication | |
| ARCHIVEBOX_USERNAME | No | Username for basic authentication | |
| EUNOMIA_POLICY_FILE | No | Policy file for embedded Eunomia | mcp_policies.json |
| REMOTE_AUTH_SERVERS | No | Comma-separated list of authorization servers for Remote OAuth | |
| OAUTH_UPSTREAM_CLIENT_ID | No | Upstream client ID for OAuth Proxy | |
| ALLOWED_CLIENT_REDIRECT_URIS | No | Comma-separated list of allowed client redirect URIs | |
| OAUTH_UPSTREAM_AUTH_ENDPOINT | No | Upstream authorization endpoint for OAuth Proxy | |
| OAUTH_UPSTREAM_CLIENT_SECRET | No | Upstream client secret for OAuth Proxy | |
| OAUTH_UPSTREAM_TOKEN_ENDPOINT | No | Upstream token endpoint for OAuth Proxy |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| get_api_token | Generate an API token for a given username & password. |
| check_api_token | Validate an API token to make sure it's valid and non-expired. |
| get_snapshots | Retrieve list of snapshots. |
| get_snapshot | Get a specific Snapshot by abid or id. |
| get_archiveresults | List all ArchiveResult entries matching these filters. |
| get_tag | Get a specific Tag by id or abid. |
| get_any | Get a specific Snapshot, ArchiveResult, or Tag by abid. |
| cli_add | Execute archivebox add command. |
| cli_update | Execute archivebox update command. |
| cli_schedule | Execute archivebox schedule command. |
| cli_list | Execute archivebox list command. |
| cli_remove | Execute archivebox remove command. |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
| cli_add_prompt | Generates a prompt for executing archivebox add command. |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
| get_instance_config | Provides the current ArchiveBox instance configuration. |