Document documents.search input shape

.changeset/clear-search-docs.md

@@ -0,0 +1,5 @@
+---
+"@typesensekit/cli": patch
+---
+
+Document the `documents.search` input shape with the required top-level `params` wrapper.

README.md

@@ -42,6 +42,19 @@ List every supported operation:
 tsk operations
 ```
 
+Inspect an operation's input shape before running it:
+
+```sh
+tsk documents.search --schema
+tsk documents.search --examples
+```
+
+Search parameters are passed inside the top-level `params` object:
+
+```sh
+tsk documents.search --input '{"collection":"production__products","params":{"q":"*","query_by":"q"}}' --json
+```
+
 ## MCP Server
 
 Run the MCP stdio server directly:

packages/cli/src/operation-docs.test.ts

@@ -38,7 +38,7 @@ describe("operation docs", () => {
 
   it("renders command-specific examples for common operations", () => {
     expect(renderOperationExamples("documents.search")).toContain(
-      `tsk documents.search --input '{"collection":"products","params":{"q":"chair","query_by":"title,description"}}' --json`,
+      `tsk documents.search --input '{"collection":"production__products","params":{"q":"*","query_by":"q"}}' --json`,
     );
     expect(renderOperationExamples("presets.create")).toContain(
       `tsk presets.create --input '{"name":"Semantic","value":{"query_by":"title_embedding"}}' --json`,

packages/cli/src/operation-docs.ts

@@ -64,10 +64,10 @@ const EXAMPLES: Record<string, JsonValue[]> = {
   ],
   "documents.search": [
     {
-      collection: "products",
+      collection: "production__products",
       params: {
-        q: "chair",
-        query_by: "title,description",
+        q: "*",
+        query_by: "q",
       },
     },
   ],