flowstate-epic-flowstate-community-epicdm-flowstate-rag-client
Package-local agent skill for @epicdm/flowstate-rag-client.
Tags
Publisher
Versions
1 version published — latest: 1.0.7
- 1.0.7publishedInvalid Date
Skill
flowstate-rag-client Package Skill
Package: @epicdm/flowstate-rag-client
Repository: epic-flowstate-community
Path: packages/flowstate-rag-client
Version: 1.0.7
Use this published Dojo skill as the package-level entrypoint. For detailed workflows, use the package-local skills listed below.
Primary Package Workflow
RAG Client Codebase Search
Status: Active
Purpose: Use metadata filters for code and codebase search correctly.
Scope: MetadataFilters, codebaseId, code collection queries, MCP codebase wrappers.
Trigger: Codebase semantic search, code context assembly, MCP codebase-search behavior review.
Input: Connected RAGClient, query, workspace/codebase metadata.
Output: Search results scoped to indexed code or codebase documents.
Workflow
Use runtime setup first. Then pass metadata/codebase filters rather than relying on broad document search.
Check MCP wrapper mappings in:
packages/flowstate-mcp/src/tools/CodebaseSearchTools.tspackages/flowstate-mcp/src/tools/RAGTools.ts
Pitfalls
- Codebase indexing schema is shared with document-store/rag-sync.
- This package validates some metadata/codebase inputs, but not every option.
- Root README omits some codebase filter behavior; source and tests are authority.
Done When
- The query is scoped to the intended codebase/workspace.
- Upstream indexed fields match
RAGClientexpectations. - MCP wrapper defaults are checked when using MCP tools.
Package Skill Inventory
Package Skill Inventory: @epicdm/flowstate-rag-client
Package Context
Package path: /Users/sthornock/code/epic/epic-flowstate-community/packages/flowstate-rag-client
This package is a local RAG query client. It should teach agents how to configure runtime dependencies and use the query workflows, not just list RAGClient.
Skill Map
| Skill | Type | Trigger | Teaches | Evidence | Depends On | Dojo |
|---|---|---|---|---|---|---|
flowstate-rag-client | orchestrator | Use when integrating or changing @epicdm/flowstate-rag-client | Routes setup, semantic context, codebase search, memory/stats, troubleshooting | src/index.ts, src/RAGClient.ts | rag-sync/document-store/mcp context | ready-after-review |
flowstate-rag-client-runtime-setup | reference | Use when configuring SurrealDB/Ollama for local RAG queries | Config fields, env mapping, model parity, rag_documents schema | RAGClientConfig, sync schema, tests | RAG sync setup | ready-after-review |
flowstate-rag-client-semantic-context | workflow | Use when performing search or building LLM context | search(), getContext(), ranking, filters, token limits, defaults | search, getContext, tests | runtime setup | ready-after-review |
flowstate-rag-client-codebase-search | workflow | Use when querying indexed code | codebaseId, MetadataFilters, code collection, MCP wrapper mapping | MetadataFilters, CodebaseSearchTools | document-store code indexer | ready-after-review |
flowstate-rag-client-memory-similarity-stats | workflow | Use when recalling memories, finding similar docs, or checking index stats | recall(), findSimilar(), getStats(), namespace/collection rules | RAGClient.ts, tests | runtime setup | ready-after-review |
flowstate-rag-client-troubleshooting-maintenance | troubleshooting | Use when RAG queries fail or docs/contracts change | Not connected, Ollama embeddings, SurrealDB errors, empty index, downstream drift | tests, MCP wrappers, smoke drift | all above | local-only |
Anti-Sprawl Decision
Six skills are appropriate: one orchestrator, one setup/schema reference, three recurring workflows, and one troubleshooting/maintenance skill. Per-method skilllets would hide shared runtime and schema constraints.
Feature Coverage
| Feature Group | Source Evidence | Covered By | Notes |
|---|---|---|---|
| Public client/export | src/index.ts | orchestrator | Single entrypoint |
| Runtime setup | RAGClientConfig, connect() | runtime setup | SurrealDB/Ollama required |
| Semantic search | search() | semantic-context | Memories excluded by default |
| Context building | getContext() | semantic-context | Rough token estimate |
| Codebase filters | MetadataFilters | codebase-search | Used by MCP wrappers |
| Memory recall | recall() | memory-similarity-stats | Namespace maps to org_id |
| Similarity lookup | findSimilar() | memory-similarity-stats | Same collection |
| Stats | getStats() | memory-similarity-stats | Missing from root README |
Composition Model
Start with the orchestrator. Load runtime setup for services/config. Choose semantic-context, codebase-search, or memory-similarity-stats by task. Use troubleshooting before changing contracts shared with MCP, rag-sync, or document-store.
Deferred Skills
- SurrealDB schema authoring belongs to sync/document-store until this package owns schema writes.
- Ollama embedding operations are limited to model parity and failure handling here.
- Dojo publish remains deferred until generated content is rebuilt.
Review Questions
- Should
zodremain a dependency or should source add schemas? - Should root README/changelog be replaced by
.flowstate/docscontent? - Should
RAGClient.search()validate query/limit/minScore/collections? - Should document-store smoke insert canonical
content/doc_idfields?
Review Gate
Package Skills Review: @epicdm/flowstate-rag-client
Verdict
Pass with fixes.
The local skillset now covers the real RAG client workflows: runtime setup, semantic context, codebase search, memory/similarity/stats, and troubleshooting. Existing generated Dojo content remains unsuitable for publication.
Findings
| Severity | Skill | Issue | Evidence | Required Fix |
|---|---|---|---|---|
| Important | all | Existing Dojo is generated from one coarse feature | .flowstate/dojo/* | Rebuild from reviewed skills |
| Important | runtime/troubleshooting | Schema ownership spans rag-sync/document-store | Source and downstream refs | Keep contract warnings in setup/troubleshooting |
| Minor | troubleshooting | Verification passed after authoring; keep this evidence current before Dojo publish | test, typecheck, build passed in this pass | Re-run before final Dojo publish if source changes |
| Minor | runtime | zod dependency not used in source | package/source | Track maintenance question |
Coverage
| Feature Group | Status | Skill | Notes |
|---|---|---|---|
| Runtime setup | Covered | runtime setup | SurrealDB/Ollama/model parity |
| Semantic search/context | Covered | semantic-context | Includes token estimate |
| Codebase filtering | Covered | codebase-search | Includes MCP wrappers |
| Memory recall/similarity/stats | Covered | memory-similarity-stats | Includes namespace semantics |
| Troubleshooting/maintenance | Covered | troubleshooting-maintenance | Includes wrapper/default drift |
Drift and Contract Risks
| Area | Risk | Evidence | Decision |
|---|---|---|---|
| Dojo | Coarse generated feature course | .flowstate/dojo/* | Rebuild before publish |
| README/changelog | Missing newer APIs/version drift | README/CHANGELOG vs source | Source is authority |
| Document-store smoke | Noncanonical fields | smoke script vs client selects | Track cross-package follow-up |
| MCP wrappers | Defaults differ from raw client | RAGTools vs search() | Teach wrapper distinction |
Dojo Publication Decision
Do not publish existing generated Dojo files. Reviewed local skills can become Dojo source after verification and manifest rebuild.
Follow-Up Work
- Package verification passed:
yarn workspace @epicdm/flowstate-rag-client testyarn workspace @epicdm/flowstate-rag-client typecheckyarn workspace @epicdm/flowstate-rag-client build
- Rebuild
.flowstate/dojoartifacts. - Decide whether to add Zod validation or remove dependency.
- Align README/changelog with source.
Usage
Start with this skill to understand the package purpose, then use the package-local focused skills for specific workflows. Keep this Dojo version aligned with packages/flowstate-rag-client/package.json. Do not treat generated feature lists as lessons; use workflow evidence from CODE-REVIEW.md, SKILL-INVENTORY.md, and REVIEW.md.
Install
Run this in your project to install via CLI:
fscloud dojo skill install flowstate-epic-flowstate-community-epicdm-flowstate-rag-client --target <target> --out ./skillsReplace <target> with your agent target identifier. See the CLI docs for details.