Commit ·
0772863
1
Parent(s): 55e3327
[KM-711] Docs: drop /report from list_skills catalog examples
Browse filesFollow-up to the button-only report change. The FE contract docs still showed
/report as a slash skill in the list_skills response example, contradicting the
shipped catalog (tools.py now exposes /help only).
- API_CONTRACT_BE_PYTHON.md: list_skills example -> count 1, /help only; note that
report is the Generate button (endpoint POST /tools/report still exists).
- API_ENDPOINTS_RESTRUCTURE.md: same example fix; "/help + /report only" -> "/help
only", /report added to the commented-out list.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
API_CONTRACT_BE_PYTHON.md
CHANGED
|
@@ -143,24 +143,22 @@ Response `200`:
|
|
| 143 |
|
| 144 |
```json
|
| 145 |
{
|
| 146 |
-
"count":
|
| 147 |
"tools": [
|
| 148 |
{
|
| 149 |
"command": "/help",
|
| 150 |
"name": "help",
|
| 151 |
"type": "skill",
|
| 152 |
"description": "Show what the assistant can do and guide your next step."
|
| 153 |
-
},
|
| 154 |
-
{
|
| 155 |
-
"command": "/report",
|
| 156 |
-
"name": "report",
|
| 157 |
-
"type": "skill",
|
| 158 |
-
"description": "Generate a versioned analysis report with background, EDA, key findings, and insights."
|
| 159 |
}
|
| 160 |
]
|
| 161 |
}
|
| 162 |
```
|
| 163 |
|
|
|
|
|
|
|
|
|
|
|
|
|
| 164 |
Tool item shape:
|
| 165 |
|
| 166 |
```json
|
|
|
|
| 143 |
|
| 144 |
```json
|
| 145 |
{
|
| 146 |
+
"count": 1,
|
| 147 |
"tools": [
|
| 148 |
{
|
| 149 |
"command": "/help",
|
| 150 |
"name": "help",
|
| 151 |
"type": "skill",
|
| 152 |
"description": "Show what the assistant can do and guide your next step."
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 153 |
}
|
| 154 |
]
|
| 155 |
}
|
| 156 |
```
|
| 157 |
|
| 158 |
+
> The catalog is `/help` only (KM-711). `/report` was removed as a slash command —
|
| 159 |
+
> report generation is a right-side **Generate** button, not a `/` command. The report
|
| 160 |
+
> HTTP endpoint (`POST /api/v1/tools/report`) still exists; the button calls it.
|
| 161 |
+
|
| 162 |
Tool item shape:
|
| 163 |
|
| 164 |
```json
|
API_ENDPOINTS_RESTRUCTURE.md
CHANGED
|
@@ -107,19 +107,18 @@ Static, deterministic, safe for Go to cache. (Was `GET /api/v1/tools`.)
|
|
| 107 |
|
| 108 |
```json
|
| 109 |
{
|
| 110 |
-
"count":
|
| 111 |
"tools": [
|
| 112 |
{ "command": "/help", "name": "help", "type": "skill",
|
| 113 |
-
"description": "Show what the assistant can do and guide your next step." }
|
| 114 |
-
{ "command": "/report", "name": "report", "type": "skill",
|
| 115 |
-
"description": "Generate a versioned analysis report (background, EDA, key findings, insights)." }
|
| 116 |
]
|
| 117 |
}
|
| 118 |
```
|
| 119 |
|
| 120 |
`CommandResponse = { command, name, type, description }`, `type ∈ {skill, analytics, data_access}`.
|
| 121 |
-
Catalog is `/help`
|
| 122 |
-
`/problem-statement` entries are commented out (kept for restorability), not deleted.
|
|
|
|
| 123 |
|
| 124 |
**FE behavior:** the `/` slash menu surfaces **`/help` only**. **Report is a right-side button, not
|
| 125 |
a slash command** (it fires only when an analysis is finished — saves tokens).
|
|
|
|
| 107 |
|
| 108 |
```json
|
| 109 |
{
|
| 110 |
+
"count": 1,
|
| 111 |
"tools": [
|
| 112 |
{ "command": "/help", "name": "help", "type": "skill",
|
| 113 |
+
"description": "Show what the assistant can do and guide your next step." }
|
|
|
|
|
|
|
| 114 |
]
|
| 115 |
}
|
| 116 |
```
|
| 117 |
|
| 118 |
`CommandResponse = { command, name, type, description }`, `type ∈ {skill, analytics, data_access}`.
|
| 119 |
+
Catalog is `/help` only; the `/report`, `analyze_*` / `check_*` / `retrieve_*`, and retired
|
| 120 |
+
`/problem-statement` entries are commented out (kept for restorability), not deleted. `/report`
|
| 121 |
+
was retired as a slash command (KM-711) — report generation is the right-side button only.
|
| 122 |
|
| 123 |
**FE behavior:** the `/` slash menu surfaces **`/help` only**. **Report is a right-side button, not
|
| 124 |
a slash command** (it fires only when an analysis is finished — saves tokens).
|