doc-sample-mcp 0.1.0 → 1.0.0
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/README.md +1 -85
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,87 +1,3 @@
|
|
|
1
1
|
# DocSample MCP
|
|
2
2
|
|
|
3
|
-
MCP server for the
|
|
4
|
-
clients to list and read documents through the dedicated `/api/mcp` endpoints.
|
|
5
|
-
|
|
6
|
-
Repository: <https://github.com/juan-malonso/doc-sample-mcp>
|
|
7
|
-
|
|
8
|
-
## Tools
|
|
9
|
-
|
|
10
|
-
- `list_documents`: list document summaries by `country` and `type`.
|
|
11
|
-
- `get_document`: get one document and its base64 files by `country`, `type`, and `id`.
|
|
12
|
-
|
|
13
|
-
## Requirements
|
|
14
|
-
|
|
15
|
-
- Node.js 20 or newer.
|
|
16
|
-
- A DocSample API key with the permissions required by the tools you want to use:
|
|
17
|
-
`mcp:list` and/or `mcp:read`.
|
|
18
|
-
|
|
19
|
-
## Install
|
|
20
|
-
|
|
21
|
-
```bash
|
|
22
|
-
git clone https://github.com/juan-malonso/doc-sample-mcp.git
|
|
23
|
-
cd doc-sample-mcp
|
|
24
|
-
npm install
|
|
25
|
-
npm run build
|
|
26
|
-
```
|
|
27
|
-
|
|
28
|
-
## MCP Client Configuration
|
|
29
|
-
|
|
30
|
-
Register the built server in your MCP client:
|
|
31
|
-
|
|
32
|
-
```json
|
|
33
|
-
{
|
|
34
|
-
"mcpServers": {
|
|
35
|
-
"doc-sample-api": {
|
|
36
|
-
"command": "node",
|
|
37
|
-
"args": ["/absolute/path/to/doc-sample-mcp/dist/index.js"],
|
|
38
|
-
"env": {
|
|
39
|
-
"DOC_SAMPLE_BASE_URL": "https://doc-sample.pages.dev",
|
|
40
|
-
"DOC_SAMPLE_API_KEY": "YOUR_API_KEY"
|
|
41
|
-
}
|
|
42
|
-
}
|
|
43
|
-
}
|
|
44
|
-
}
|
|
45
|
-
```
|
|
46
|
-
|
|
47
|
-
For local development:
|
|
48
|
-
|
|
49
|
-
```json
|
|
50
|
-
{
|
|
51
|
-
"mcpServers": {
|
|
52
|
-
"doc-sample-api-local": {
|
|
53
|
-
"command": "node",
|
|
54
|
-
"args": ["/absolute/path/to/doc-sample-mcp/dist/index.js"],
|
|
55
|
-
"env": {
|
|
56
|
-
"DOC_SAMPLE_BASE_URL": "http://localhost:3000",
|
|
57
|
-
"DOC_SAMPLE_API_KEY": "YOUR_API_KEY"
|
|
58
|
-
}
|
|
59
|
-
}
|
|
60
|
-
}
|
|
61
|
-
}
|
|
62
|
-
```
|
|
63
|
-
|
|
64
|
-
## Publish To npm
|
|
65
|
-
|
|
66
|
-
The package is ready to publish if you want one-command installs:
|
|
67
|
-
|
|
68
|
-
```bash
|
|
69
|
-
npm publish --access public
|
|
70
|
-
```
|
|
71
|
-
|
|
72
|
-
After publishing, MCP clients can use `npx`:
|
|
73
|
-
|
|
74
|
-
```json
|
|
75
|
-
{
|
|
76
|
-
"mcpServers": {
|
|
77
|
-
"doc-sample-api": {
|
|
78
|
-
"command": "npx",
|
|
79
|
-
"args": ["-y", "doc-sample-mcp"],
|
|
80
|
-
"env": {
|
|
81
|
-
"DOC_SAMPLE_BASE_URL": "https://doc-sample.pages.dev",
|
|
82
|
-
"DOC_SAMPLE_API_KEY": "YOUR_API_KEY"
|
|
83
|
-
}
|
|
84
|
-
}
|
|
85
|
-
}
|
|
86
|
-
}
|
|
87
|
-
```
|
|
3
|
+
MCP server for the API.
|