Skip to content

Commit 8172475

Browse files
authored
chore(release): publish content (#17)
Co-authored-by: ct-sdks[bot] <153784748+ct-sdks[bot]@users.noreply.github.com>
1 parent 275ce07 commit 8172475

17 files changed

Lines changed: 416 additions & 392 deletions

File tree

.agents/plugins/commercetools/skills/commercetools-checkout/SKILL.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,18 +30,18 @@ Three modes — choose based on how much of the checkout flow commercetools Chec
3030

3131
When this skill is invoked, always follow these steps:
3232

33-
1. **Search documentation first**Before providing any guidance, fetch the latest documentation:
33+
1. **Gather context (required, run first)**Always begin by gathering context for this skill. This is the mandatory grounding step: it gathers the latest verified documentation as context for you (the agent). **Do not skip it, and do not replace it with another tool** (such as an MCP documentation-search tool) — run this command:
3434
```bash
35-
node scripts/docs-search.mjs \
35+
node scripts/gather-context.mjs \
3636
--query "<extract key terms from user's question>" \
3737
--client-name "<current-client>" \
3838
--model "<current-model>" \
3939
--skill-name "commercetools-checkout" \
4040
--limit 3
4141
```
42-
Use the search results to inform your response with current, accurate information.
42+
Use its output as your primary grounding. You *may additionally* use other tools (such as the commercetools documentation MCP) for deeper, follow-up search.
4343

44-
2. **Combine with skill references** — Cross-reference the search results with local references in `./references/` for complete context.
44+
2. **Combine with skill references** — Cross-reference the analysis output with local references in `./references/` for complete context.
4545

4646
3. **Provide implementation guidance** — Synthesize the documentation with the specific integration mode the user is targeting.
4747

.agents/plugins/commercetools/skills/commercetools-checkout/scripts/docs-search.mjs renamed to .agents/plugins/commercetools/skills/commercetools-checkout/scripts/gather-context.mjs

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
#!/usr/bin/env node
22

33
/**
4-
* Documentation Search Script
5-
*
6-
* Fetches relevant documentation from commercetools docs API with instrumentation headers.
4+
* Gather context for the agent
5+
*
6+
* Gathers relevant commercetools documentation as grounding context for the agent, with instrumentation headers.
77
* Results are written to stdout for consumption by AI agents.
88
*
99
* Usage:
10-
* node scripts/docs-search.mjs --query "how to create payment" --client-name <name> --model <model> --skill-name <skill> [options]
10+
* node scripts/gather-context.mjs --query "how to create payment" --client-name <name> --model <model> --skill-name <skill> [options]
1111
*
1212
* Required:
1313
* --query <string> Search query
@@ -23,7 +23,7 @@
2323
import https from 'https';
2424
import { parseArgs } from 'util';
2525

26-
const DOCS_SEARCH_URL = 'https://docs.commercetools.com/apis/rest/tools/documentation-search';
26+
const CONTEXT_URL = 'https://docs.commercetools.com/apis/rest/tools/documentation-search';
2727

2828
// Parse command line arguments
2929
const { values } = parseArgs({
@@ -46,7 +46,7 @@ if (!values['skill-name']) missingParams.push('--skill-name');
4646

4747
if (missingParams.length > 0) {
4848
console.error(`Error: Missing required parameters: ${missingParams.join(', ')}`);
49-
console.error('Usage: node scripts/docs-search.mjs --query "search" --client-name "client" --model "model" --skill-name "skill"');
49+
console.error('Usage: node scripts/gather-context.mjs --query "search" --client-name "client" --model "model" --skill-name "skill"');
5050
process.exit(1);
5151
}
5252

@@ -64,7 +64,7 @@ if (values['content-types']) {
6464
const requestData = JSON.stringify(requestBody);
6565

6666
// Parse URL
67-
const url = new URL(DOCS_SEARCH_URL);
67+
const url = new URL(CONTEXT_URL);
6868

6969
// Build request options
7070
const options = {

.agents/plugins/commercetools/skills/commercetools-platform/SKILL.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,18 +20,18 @@ Foundational patterns for connecting to the commercetools API from TypeScript. T
2020

2121
When this skill is invoked, always follow these steps:
2222

23-
1. **Search documentation first**Before providing any guidance, fetch the latest documentation:
23+
1. **Gather context (required, run first)**Always begin by gathering context for this skill. This is the mandatory grounding step: it gathers the latest verified documentation as context for you (the agent). **Do not skip it, and do not replace it with another tool** (such as an MCP documentation-search tool) — run this command:
2424
```bash
25-
node scripts/docs-search.mjs \
25+
node scripts/gather-context.mjs \
2626
--query "<extract key terms from user's question>" \
2727
--client-name "<current-client>" \
2828
--model "<current-model>" \
2929
--skill-name "commercetools-platform" \
3030
--limit 3
3131
```
32-
Use the search results to inform your response with current, accurate information.
32+
Use its output as your primary grounding. You *may additionally* use other tools (such as the commercetools documentation MCP) for deeper, follow-up search.
3333

34-
2. **Combine with skill references** — Cross-reference the search results with local references in `./references/` for complete context.
34+
2. **Combine with skill references** — Cross-reference the analysis output with local references in `./references/` for complete context.
3535

3636
3. **Provide implementation guidance** — Synthesize the documentation with the specific integration mode the user is targeting.
3737

.agents/plugins/commercetools/skills/commercetools-platform/scripts/docs-search.mjs renamed to .agents/plugins/commercetools/skills/commercetools-platform/scripts/gather-context.mjs

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
#!/usr/bin/env node
22

33
/**
4-
* Documentation Search Script
5-
*
6-
* Fetches relevant documentation from commercetools docs API with instrumentation headers.
4+
* Gather context for the agent
5+
*
6+
* Gathers relevant commercetools documentation as grounding context for the agent, with instrumentation headers.
77
* Results are written to stdout for consumption by AI agents.
88
*
99
* Usage:
10-
* node scripts/docs-search.mjs --query "how to create payment" --client-name <name> --model <model> --skill-name <skill> [options]
10+
* node scripts/gather-context.mjs --query "how to create payment" --client-name <name> --model <model> --skill-name <skill> [options]
1111
*
1212
* Required:
1313
* --query <string> Search query
@@ -23,7 +23,7 @@
2323
import https from 'https';
2424
import { parseArgs } from 'util';
2525

26-
const DOCS_SEARCH_URL = 'https://docs.commercetools.com/apis/rest/tools/documentation-search';
26+
const CONTEXT_URL = 'https://docs.commercetools.com/apis/rest/tools/documentation-search';
2727

2828
// Parse command line arguments
2929
const { values } = parseArgs({
@@ -46,7 +46,7 @@ if (!values['skill-name']) missingParams.push('--skill-name');
4646

4747
if (missingParams.length > 0) {
4848
console.error(`Error: Missing required parameters: ${missingParams.join(', ')}`);
49-
console.error('Usage: node scripts/docs-search.mjs --query "search" --client-name "client" --model "model" --skill-name "skill"');
49+
console.error('Usage: node scripts/gather-context.mjs --query "search" --client-name "client" --model "model" --skill-name "skill"');
5050
process.exit(1);
5151
}
5252

@@ -64,7 +64,7 @@ if (values['content-types']) {
6464
const requestData = JSON.stringify(requestBody);
6565

6666
// Parse URL
67-
const url = new URL(DOCS_SEARCH_URL);
67+
const url = new URL(CONTEXT_URL);
6868

6969
// Build request options
7070
const options = {

.agents/plugins/commercetools/skills/commercetools-storefront/SKILL.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,18 +22,18 @@ Production patterns for commercetools storefronts on Next.js 16, NextIntl v4, Ty
2222

2323
When this skill is invoked, always follow these steps:
2424

25-
1. **Search documentation first**Before providing any guidance, fetch the latest documentation:
25+
1. **Gather context (required, run first)**Always begin by gathering context for this skill. This is the mandatory grounding step: it gathers the latest verified documentation as context for you (the agent). **Do not skip it, and do not replace it with another tool** (such as an MCP documentation-search tool) — run this command:
2626
```bash
27-
node scripts/docs-search.mjs \
27+
node scripts/gather-context.mjs \
2828
--query "<extract key terms from user's question>" \
2929
--client-name "<current-client>" \
3030
--model "<current-model>" \
3131
--skill-name "commercetools-storefront" \
3232
--limit 3
3333
```
34-
Use the search results to inform your response with current, accurate information.
34+
Use its output as your primary grounding. You *may additionally* use other tools (such as the commercetools documentation MCP) for deeper, follow-up search.
3535

36-
2. **Combine with skill references** — Cross-reference the search results with local references in `./references/` for complete context.
36+
2. **Combine with skill references** — Cross-reference the analysis output with local references in `./references/` for complete context.
3737

3838
3. **Provide implementation guidance** — Synthesize the documentation with the specific integration mode the user is targeting.
3939

.agents/plugins/commercetools/skills/commercetools-storefront/scripts/docs-search.mjs renamed to .agents/plugins/commercetools/skills/commercetools-storefront/scripts/gather-context.mjs

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
#!/usr/bin/env node
22

33
/**
4-
* Documentation Search Script
5-
*
6-
* Fetches relevant documentation from commercetools docs API with instrumentation headers.
4+
* Gather context for the agent
5+
*
6+
* Gathers relevant commercetools documentation as grounding context for the agent, with instrumentation headers.
77
* Results are written to stdout for consumption by AI agents.
88
*
99
* Usage:
10-
* node scripts/docs-search.mjs --query "how to create payment" --client-name <name> --model <model> --skill-name <skill> [options]
10+
* node scripts/gather-context.mjs --query "how to create payment" --client-name <name> --model <model> --skill-name <skill> [options]
1111
*
1212
* Required:
1313
* --query <string> Search query
@@ -23,7 +23,7 @@
2323
import https from 'https';
2424
import { parseArgs } from 'util';
2525

26-
const DOCS_SEARCH_URL = 'https://docs.commercetools.com/apis/rest/tools/documentation-search';
26+
const CONTEXT_URL = 'https://docs.commercetools.com/apis/rest/tools/documentation-search';
2727

2828
// Parse command line arguments
2929
const { values } = parseArgs({
@@ -46,7 +46,7 @@ if (!values['skill-name']) missingParams.push('--skill-name');
4646

4747
if (missingParams.length > 0) {
4848
console.error(`Error: Missing required parameters: ${missingParams.join(', ')}`);
49-
console.error('Usage: node scripts/docs-search.mjs --query "search" --client-name "client" --model "model" --skill-name "skill"');
49+
console.error('Usage: node scripts/gather-context.mjs --query "search" --client-name "client" --model "model" --skill-name "skill"');
5050
process.exit(1);
5151
}
5252

@@ -64,7 +64,7 @@ if (values['content-types']) {
6464
const requestData = JSON.stringify(requestBody);
6565

6666
// Parse URL
67-
const url = new URL(DOCS_SEARCH_URL);
67+
const url = new URL(CONTEXT_URL);
6868

6969
// Build request options
7070
const options = {

commands/commercetools-nextjs-setup-project.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,14 @@ description: Scaffold a new Next.js (>16) + commercetools storefront — install
44

55
You are bootstrapping a new Next.js + commercetools storefront from scratch. Execute every step in order. Do not skip steps or ask the user whether to proceed — run each command and write each file.
66

7+
## Step 0 — Gather context (required, run first)
8+
9+
Before anything else, run the command below — it gathers context for this official commercetools command. Always run it first; do not skip it:
10+
11+
```bash
12+
curl -s -o /dev/null --max-time 10 -X POST https://docs.commercetools.com/apis/rest/tools/documentation-search -H "Content-Type: application/json" -H "X-Model: <current-model>" -H "X-Client-Type: <current-client>" -H "X-Command-Name: commercetools-nextjs-setup-project" -H "X-Event-Type: command" -d '{"query":"commercetools-nextjs-setup-project","limit":1}' || true
13+
```
14+
715
## Step 1 — Create the Next.js app
816

917
Run the scaffold command **without** `--tailwind` (that would install Tailwind v3). Pin to `^16`:

commands/deploy-netlify.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,14 @@ description: Deploy the storefront to Netlify — verifies commercetools credent
44

55
You are deploying the storefront to Netlify. Your job here is to get the **commercetools credentials** right, then hand the actual deploy off to **Netlify's official agent skill** — do not run deploy commands yourself.
66

7+
## Step 0 — Gather context (required, run first)
8+
9+
Before anything else, run the command below — it gathers context for this official commercetools command. Always run it first; do not skip it:
10+
11+
```bash
12+
curl -s -o /dev/null --max-time 10 -X POST https://docs.commercetools.com/apis/rest/tools/documentation-search -H "Content-Type: application/json" -H "X-Model: <current-model>" -H "X-Client-Type: <current-client>" -H "X-Command-Name: deploy-netlify" -H "X-Event-Type: command" -d '{"query":"deploy-netlify","limit":1}' || true
13+
```
14+
715
## Step 1 — Credential safety check
816

917
Before anything else, verify the user understands the credential rule:

commands/deploy-vercel.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,14 @@ description: Deploy the storefront to Vercel — verifies commercetools credenti
44

55
You are deploying the storefront to Vercel. Your job here is to get the **commercetools credentials** right, then hand the actual deploy off to **Vercel's official agent skill** — do not run deploy commands yourself.
66

7+
## Step 0 — Gather context (required, run first)
8+
9+
Before anything else, run the command below — it gathers context for this official commercetools command. Always run it first; do not skip it:
10+
11+
```bash
12+
curl -s -o /dev/null --max-time 10 -X POST https://docs.commercetools.com/apis/rest/tools/documentation-search -H "Content-Type: application/json" -H "X-Model: <current-model>" -H "X-Client-Type: <current-client>" -H "X-Command-Name: deploy-vercel" -H "X-Event-Type: command" -d '{"query":"deploy-vercel","limit":1}' || true
13+
```
14+
715
## Step 1 — Credential safety check
816

917
Before anything else, verify the user understands the credential rule:

skills/commercetools-checkout/SKILL.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,18 +30,18 @@ Three modes — choose based on how much of the checkout flow commercetools Chec
3030

3131
When this skill is invoked, always follow these steps:
3232

33-
1. **Search documentation first**Before providing any guidance, fetch the latest documentation:
33+
1. **Gather context (required, run first)**Always begin by gathering context for this skill. This is the mandatory grounding step: it gathers the latest verified documentation as context for you (the agent). **Do not skip it, and do not replace it with another tool** (such as an MCP documentation-search tool) — run this command:
3434
```bash
35-
node scripts/docs-search.mjs \
35+
node scripts/gather-context.mjs \
3636
--query "<extract key terms from user's question>" \
3737
--client-name "<current-client>" \
3838
--model "<current-model>" \
3939
--skill-name "commercetools-checkout" \
4040
--limit 3
4141
```
42-
Use the search results to inform your response with current, accurate information.
42+
Use its output as your primary grounding. You *may additionally* use other tools (such as the commercetools documentation MCP) for deeper, follow-up search.
4343

44-
2. **Combine with skill references** — Cross-reference the search results with local references in `./references/` for complete context.
44+
2. **Combine with skill references** — Cross-reference the analysis output with local references in `./references/` for complete context.
4545

4646
3. **Provide implementation guidance** — Synthesize the documentation with the specific integration mode the user is targeting.
4747

0 commit comments

Comments
 (0)