Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| CKAN_API_KEY | No | API key used when the selected portal requires authentication. | |
| CKAN_BASE_URL | No | Optional default Action API base; sessions can override via ckan_api_initialise. | |
| CKAN_MCP_HOST | No | Bind host when CKAN_MCP_MODE=http. | 0.0.0.0 |
| CKAN_MCP_MODE | No | stdio for CLI integrations, http for streamable HTTP transport. | stdio |
| CKAN_MCP_PORT | No | Bind port for HTTP mode. | 8000 |
| CKAN_SITE_URL | No | Root site URL used for dataset links. | |
| CKAN_MCP_HTTP_PATH | No | Mount path for HTTP transport (used both by builtin HTTP server and Cloud Run deployments). | /mcp |
| CKAN_MCP_HTTP_LOG_LEVEL | No | Log verbosity for HTTP transport. | info |
| CKAN_MCP_LOCAL_DATASTORE | No | Local directory path where downloaded datasets are stored. Defaults to current working directory if not set. | ./ |
| CKAN_DATASET_URL_TEMPLATE | No | Overrides dataset page URL format ({name} and {id} supported). | |
| CKAN_MCP_HTTP_ALLOW_ORIGINS | No | CORS allowlist for HTTP mode. | * |
| CKAN_MCP_HTTP_JSON_RESPONSE | No | Emit JSON responses instead of SSE when true. | false |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| ckan_api_initialise | Select which CKAN portal this MCP session should use |
| ckan_api_availability | List the configured CKAN portals and show the current selection when available |
| audit_ckan_api | Review the active CKAN endpoint for specification deviations and configuration overrides |
| get_package | Fetch complete dataset metadata by ID |
| get_first_datastore_resource_records | Get records from the first active datastore resource in a dataset |
| get_resource_records | Get records from a specific datastore resource |
| list_datasets | List all available datasets with pagination |
| search_datasets | Search datasets by keyword |
| find_relevant_datasets | Intelligent dataset discovery with relevance scoring |
| analyze_dataset_updates | Update frequency analysis with categorization |
| analyze_dataset_structure | Deep data structure analysis with field definitions |
| get_data_categories | Explore organizations and topic groups |
| get_dataset_insights | Comprehensive analysis combining multiple dimensions |
| download_dataset_locally | Download a dataset resource, metadata, and usage guide to the local filesystem using curl |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |