@jaypie/mcp 0.8.65 → 0.8.66
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/dist/suites/docs/index.js +1 -1
- package/package.json +1 -1
- package/release-notes/mcp/0.8.66.md +14 -0
- package/skills/api.md +25 -8
|
@@ -9,7 +9,7 @@ import { gt } from 'semver';
|
|
|
9
9
|
/**
|
|
10
10
|
* Docs Suite - Documentation services (skill, version, release_notes)
|
|
11
11
|
*/
|
|
12
|
-
const BUILD_VERSION_STRING = "@jaypie/mcp@0.8.
|
|
12
|
+
const BUILD_VERSION_STRING = "@jaypie/mcp@0.8.66#da12e12f"
|
|
13
13
|
;
|
|
14
14
|
const __filename$1 = fileURLToPath(import.meta.url);
|
|
15
15
|
const __dirname$1 = path.dirname(__filename$1);
|
package/package.json
CHANGED
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
version: 0.8.66
|
|
3
|
+
date: 2026-06-05
|
|
4
|
+
summary: Document request envelope in skill("api") — requests use the same { data } object-vs-array rules as responses
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Changed
|
|
8
|
+
|
|
9
|
+
- **`api` skill** now documents the **request envelope**. Request bodies follow
|
|
10
|
+
the same `{ data }` convention as responses: `{ data: {} }` for a single record
|
|
11
|
+
(object), `{ data: [] }` for an array of records. The request rule was
|
|
12
|
+
previously undocumented in every skill file — only response format was covered.
|
|
13
|
+
- Retitled the skill to **API Request and Response Format** and added a request
|
|
14
|
+
rule to the shared rules list.
|
package/skills/api.md
CHANGED
|
@@ -1,11 +1,27 @@
|
|
|
1
1
|
---
|
|
2
|
-
description: API response format and conventions
|
|
2
|
+
description: API request and response format and conventions
|
|
3
3
|
related: express, handlers, style
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
# API Response Format
|
|
6
|
+
# API Request and Response Format
|
|
7
7
|
|
|
8
|
-
All API responses follow a consistent envelope format.
|
|
8
|
+
All API requests and responses follow a consistent envelope format.
|
|
9
|
+
|
|
10
|
+
## Request Envelope
|
|
11
|
+
|
|
12
|
+
Request bodies follow the same `{ data }` envelope as responses.
|
|
13
|
+
|
|
14
|
+
```json
|
|
15
|
+
// Single record
|
|
16
|
+
{ "data": { "name": "Example" } }
|
|
17
|
+
|
|
18
|
+
// Array of records
|
|
19
|
+
{ "data": [{ "name": "First" }, { "name": "Second" }] }
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
- `{ data: {} }` — single record (object)
|
|
23
|
+
- `{ data: [] }` — array of records (even if zero or one result)
|
|
24
|
+
- No other top-level keys at the root
|
|
9
25
|
|
|
10
26
|
## Response Envelope
|
|
11
27
|
|
|
@@ -39,8 +55,9 @@ Every response body is a JSON object with one top-level key:
|
|
|
39
55
|
|
|
40
56
|
### Rules
|
|
41
57
|
|
|
42
|
-
1.
|
|
43
|
-
2.
|
|
44
|
-
3.
|
|
45
|
-
4.
|
|
46
|
-
5.
|
|
58
|
+
1. Requests and responses both use the `{ data }` envelope
|
|
59
|
+
2. A response contains either `data` or `errors`, never both
|
|
60
|
+
3. Single records use an object: `{ data: {} }`
|
|
61
|
+
4. Multiple records use an array: `{ data: [] }`
|
|
62
|
+
5. Errors always use an array: `{ errors: [] }` (responses only)
|
|
63
|
+
6. No other top-level keys (no `status`, `message`, `meta` at the root)
|