@simpleapps-com/augur-skills 0.0.13 → 0.0.16

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.
Files changed (2) hide show
  1. package/package.json +1 -1
  2. package/skills/simpleapps/augur-api/SKILL.md +42 -12
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@simpleapps-com/augur-skills",
3
- "version": "0.0.13",
3
+ "version": "0.0.16",
4
4
  "description": "Install curated Claude Code skills",
5
5
  "license": "MIT",
6
6
  "type": "module",
package/skills/simpleapps/augur-api/SKILL.md CHANGED
@@ -1,51 +1,81 @@
1
1
  ---
2
2
  name: augur-api
3
- description: Augur API integration via MCP. Covers service discovery, CRUD operations across all 27 Augur microservices, and credential resolution. Use when querying or modifying Augur data (contacts, transactions, inventory, etc.).
3
+ description: Augur API integration via MCP. Covers service discovery, multi-site CRUD operations across Augur microservices, and credential resolution. Use when querying or modifying Augur data (contacts, transactions, inventory, etc.).
4
4
  ---
5
5
 
6
6
  # Augur API
7
7
 
8
- MCP server exposing all 27 Augur microservices through 6 generic tools.
8
+ MCP server exposing Augur microservices through 7 generic tools.
9
9
 
10
10
  ## Tools
11
11
 
12
12
  | Tool | Purpose |
13
13
  |------|---------|
14
14
  | `augur_discover` | List services or endpoints for a service |
15
+ | `augur_sites` | List configured sites with default flag |
15
16
  | `augur_list` | List records (GET collection) |
16
17
  | `augur_get` | Get single record by ID |
17
18
  | `augur_create` | Create record (POST) |
18
19
  | `augur_update` | Update record (PUT) |
19
20
  | `augur_delete` | Delete record (DELETE) |
20
21
 
22
+ All 5 data tools (`augur_list`, `augur_get`, `augur_create`, `augur_update`, `augur_delete`) accept an optional `site` parameter to target a specific site. Omit `site` to use the default.
23
+
21
24
  ## Usage Pattern
22
25
 
23
26
  Always start with discovery:
24
27
 
25
- 1. `augur_discover()` — lists all available services
26
- 2. `augur_discover(service="<name>")` — lists endpoints for a specific service
27
- 3. Use `augur_list`, `augur_get`, `augur_create`, `augur_update`, `augur_delete` for CRUD
28
+ 1. `augur_sites()` — see which sites are configured and which is default
29
+ 2. `augur_discover()` — lists all available services
30
+ 3. `augur_discover(service="<name>")` — lists endpoints for a specific service
31
+ 4. Use data tools for CRUD, passing `site` when targeting a non-default site
28
32
 
29
33
  Do NOT hardcode service names or endpoints. Use `augur_discover` to find them at runtime.
30
34
 
31
35
  ## Authentication
32
36
 
33
- Credentials resolve automatically — no setup needed if running from a project directory with a `protected/` folder containing credentials.
37
+ Credentials resolve automatically from `.simpleapps/` directories.
34
38
 
35
39
  Resolution order (first match wins):
36
40
 
37
41
  1. **Env vars** — `AUGUR_TOKEN` + `AUGUR_SITE_ID`
38
42
  2. **Explicit file** — `AUGUR_CREDS_FILE` env var pointing to a JSON file
39
- 3. **Ancestor walk** — walks up from cwd looking for `protected/*.json`
40
- 4. **Default file** — `~/.simpleapps/augur-api.json`
43
+ 3. **Project file** — `<cwd>/.simpleapps/augur-api.json`
44
+ 4. **Global file** — `~/.simpleapps/augur-api.json`
45
+
46
+ Project and global files are merged (project takes precedence).
47
+
48
+ ### Single-site format
49
+
50
+ ```json
51
+ {
52
+ "siteId": "my-site",
53
+ "jwt": "my-token"
54
+ }
55
+ ```
56
+
57
+ ### Multi-site format
58
+
59
+ ```json
60
+ {
61
+ "site-a": { "jwt": "token-a" },
62
+ "site-b": { "jwt": "token-b" }
63
+ }
64
+ ```
65
+
66
+ ## API Reference
67
+
68
+ Documentation hub: https://augur-api.info/
41
69
 
42
- Credentials file format: `{"siteId": "...", "jwt": "..."}`
70
+ - **Service directory** — https://items.augur-api.com/llms.txt lists all available services
71
+ - **Per-service docs** — `https://{service}.augur-api.com/llms.txt` (LLM-friendly), `/openapi.json`, `/postman.json`, `/endpoints.jsonl`
72
+ - **FAQ for agents** — https://augur-api.info/faq.md (auth, pagination, rate limits)
43
73
 
44
- The ancestor walk means client project directories with `protected/<client>.json` just work.
74
+ Services include items, pricing, commerce, orders, customers, payments, shipping, open-search, and more. Use `augur_discover` at runtime rather than hardcoding service names.
45
75
 
46
76
  ## When Auth Fails
47
77
 
48
78
  If tools return authentication errors:
49
- - Check for `protected/*.json` in the project directory or any ancestor
50
- - Verify the file contains valid `siteId` and `jwt` keys
79
+ - Check for `.simpleapps/augur-api.json` in the project directory or home directory
80
+ - Verify the file contains valid credentials (single-site or multi-site format)
51
81
  - Fallback: set `AUGUR_TOKEN` and `AUGUR_SITE_ID` env vars