Skip to content

Commit 6742b2d

Browse files
committed
brainkb skill: always register graphs/spaces with a description
Registering a graph without a description leaves an empty description in the graph registry (and provenance/listings). Instruct the skill to always pass a non-empty description on brainkb_add_space_graph and brainkb_create_space (ask the user or derive one), and update the end-to-end example accordingly.
1 parent dcb2eee commit 6742b2d

1 file changed

Lines changed: 10 additions & 4 deletions

File tree

skills/brainkb_skills/SKILL.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -69,10 +69,16 @@ The base URL must be reachable **from wherever this code runs**:
6969
Call `brainkb_login(email, password, base_url?)`. Confirm with `brainkb_whoami()`.
7070

7171
### 2. Create / choose a workspace (space)
72-
- New private workspace: `brainkb_create_space(slug, name, "private")`.
72+
- New private workspace: `brainkb_create_space(slug, name, "private", description)`.
7373
- Bind a named graph to it (required before ingesting into that graph):
74-
`brainkb_add_space_graph(slug, graph_iri)``graph_iri` like
74+
`brainkb_add_space_graph(slug, graph_iri, description)``graph_iri` like
7575
`https://brainkb.org/graph/<slug>/`.
76+
- **Always pass a non-empty `description`** when registering a graph (and when
77+
creating a space). The description is stored in the graph registry and surfaces
78+
in provenance / listings — leaving it blank leaves the graph undocumented (it
79+
shows up with an empty description). If the user didn't give one, ask for a short
80+
description, or derive a sensible one from the space/graph name and the data
81+
being ingested; don't silently register with an empty description.
7682
- List what the user can see: `brainkb_list_spaces()`.
7783

7884
### 3. Ingest
@@ -109,8 +115,8 @@ Call `brainkb_login(email, password, base_url?)`. Confirm with `brainkb_whoami()
109115
## Typical end-to-end
110116

111117
1. `brainkb_login(...)`
112-
2. `brainkb_create_space("my-lab", "My Lab", "private")`
113-
3. `brainkb_add_space_graph("my-lab", "https://brainkb.org/graph/my-lab/")`
118+
2. `brainkb_create_space("my-lab", "My Lab", "private", "My lab's working data")`
119+
3. `brainkb_add_space_graph("my-lab", "https://brainkb.org/graph/my-lab/", "My lab cell-type annotations")` ← always give a description
114120
4. `brainkb_ingest_text("https://brainkb.org/graph/my-lab/", "<ttl>")` → job_id
115121
5. poll `brainkb_job_status(job_id)` until `done`
116122
6. `brainkb_search("<term>", space="my-lab")` / `brainkb_provenance_graph(iri)`

0 commit comments

Comments
 (0)