@aborruso/ckan-mcp-server 0.4.9 → 0.4.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.devin/wiki.json +273 -0
- package/AGENTS.md +32 -137
- package/CLAUDE.md +18 -0
- package/LOG.md +8 -0
- package/README.md +44 -5
- package/dist/index.js +238 -1
- package/dist/worker.js +158 -44
- package/openspec/changes/add-mcp-prompts/proposal.md +13 -0
- package/openspec/changes/add-mcp-prompts/specs/mcp-prompts/spec.md +22 -0
- package/openspec/changes/add-mcp-prompts/tasks.md +10 -0
- package/package.json +1 -1
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# Change: Add MCP Guided Prompts
|
|
2
|
+
|
|
3
|
+
## Why
|
|
4
|
+
Users often need guidance to use CKAN tools correctly; guided prompts reduce misuse and speed up discovery workflows.
|
|
5
|
+
|
|
6
|
+
## What Changes
|
|
7
|
+
- Add a new MCP prompts capability with reusable guided prompts for common tasks.
|
|
8
|
+
- Register prompts in the MCP server so clients can discover and invoke them.
|
|
9
|
+
- Document prompts and examples in README/docs.
|
|
10
|
+
|
|
11
|
+
## Impact
|
|
12
|
+
- Affected specs: mcp-prompts (new)
|
|
13
|
+
- Affected code: `src/server.ts`, new `src/prompts/*`, docs/README
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
## ADDED Requirements
|
|
2
|
+
|
|
3
|
+
### Requirement: Guided prompts are available
|
|
4
|
+
The system SHALL expose a set of guided MCP prompts for common CKAN discovery workflows.
|
|
5
|
+
|
|
6
|
+
#### Scenario: User requests a guided search prompt
|
|
7
|
+
- **WHEN** a client lists MCP prompts
|
|
8
|
+
- **THEN** the guided prompts are returned with name, description, and parameters
|
|
9
|
+
|
|
10
|
+
### Requirement: Prompt output includes tool usage instructions
|
|
11
|
+
Each guided prompt SHALL produce instructions that reference the appropriate CKAN tools and parameters.
|
|
12
|
+
|
|
13
|
+
#### Scenario: Prompt generation for thematic search
|
|
14
|
+
- **WHEN** the user generates a prompt for a specific theme and format
|
|
15
|
+
- **THEN** the output includes the correct tool name and required parameters
|
|
16
|
+
|
|
17
|
+
### Requirement: Prompt content is localized and consistent
|
|
18
|
+
Guided prompts SHALL use consistent language and parameter naming aligned with CKAN tool schemas.
|
|
19
|
+
|
|
20
|
+
#### Scenario: Prompt content consistency
|
|
21
|
+
- **WHEN** a prompt is generated
|
|
22
|
+
- **THEN** parameter names match the tool schema (e.g., `server_url`, `q`, `fq`, `rows`)
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
## 1. Implementation
|
|
2
|
+
- [x] Add prompt generators for guided search workflows (theme, organization, format, recent datasets, dataset analysis)
|
|
3
|
+
- [x] Register prompts in MCP server for discovery
|
|
4
|
+
- [x] Update README/docs with prompt usage examples
|
|
5
|
+
|
|
6
|
+
## 2. Tests
|
|
7
|
+
- [x] Add unit tests for prompt output structure and parameters
|
|
8
|
+
|
|
9
|
+
## 3. Validation
|
|
10
|
+
- [x] Run `npm test` (optional if CI)
|