@neuralis/brain-core 0.3.2 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +79 -1409
- package/app/README.md +1 -1
- package/app/cards/FilesystemCardShell.tsx +42 -4
- package/app/cards/FilesystemChangeCard.tsx +34 -11
- package/app/cards/README.md +6 -5
- package/app/cards/diffUtils.ts +99 -1
- package/app/filesystem/FilesystemHost.tsx +17 -2
- package/app/filesystem/api/README.md +3 -3
- package/app/filesystem/api/index.ts +35 -11
- package/app/filesystem/api/projectPackages.ts +13 -102
- package/app/filesystem/domain/types.ts +30 -10
- package/app/filesystem/hooks/README.md +3 -3
- package/app/filesystem/hooks/useDiscoverableSources.ts +19 -30
- package/app/filesystem/hooks/useFilesystemSSE.ts +1 -1
- package/app/filesystem/host/README.md +5 -3
- package/app/filesystem/host/buildFilesystemHostValue.ts +19 -0
- package/app/filesystem/host/installFilesystemHostComponents.tsx +1 -1
- package/app/filesystem/lib/sourceKindForm.ts +118 -39
- package/app/filesystem/lib/treeVisualState.tsx +98 -4
- package/app/filesystem/store/README.md +1 -0
- package/app/filesystem/store/filesystemStore.ts +86 -5
- package/app/filesystem/store/gitSlice.ts +5 -0
- package/app/filesystem/store/helpers.ts +17 -0
- package/app/filesystem/store/listSlice.ts +8 -0
- package/app/filesystem/ui/CodeEditor.tsx +18 -3
- package/app/filesystem/ui/FileEditor.tsx +15 -10
- package/app/filesystem/ui/FileTree.tsx +41 -16
- package/app/filesystem/ui/FolderPicker.tsx +251 -0
- package/app/filesystem/ui/GitControlPanel.tsx +5 -0
- package/app/filesystem/ui/PackagesPanel.tsx +52 -374
- package/app/filesystem/ui/PolicyEditor.tsx +109 -24
- package/app/filesystem/ui/README.md +17 -11
- package/app/filesystem/ui/RawMediaPreview.tsx +58 -0
- package/app/filesystem/ui/SourceBranchHeader.tsx +4 -4
- package/app/filesystem/ui/SourcesPanel.tsx +420 -360
- package/app/filesystem/ui/Toolbar.tsx +1 -2
- package/app/shared/filesystem.png +0 -0
- package/dist/app/host.js +57 -49
- package/dist/scripts/sourceRootPairV1.d.ts +47 -0
- package/dist/scripts/sourceRootPairV1.d.ts.map +1 -0
- package/dist/scripts/sourceRootPairV1.js +147 -0
- package/dist/scripts/sourceRootPairV1.js.map +1 -0
- package/dist/scripts/sourceToFolderV1.d.ts +56 -0
- package/dist/scripts/sourceToFolderV1.d.ts.map +1 -0
- package/dist/scripts/sourceToFolderV1.js +152 -0
- package/dist/scripts/sourceToFolderV1.js.map +1 -0
- package/dist/scripts/sourceToHostV1.d.ts +56 -0
- package/dist/scripts/sourceToHostV1.d.ts.map +1 -0
- package/dist/scripts/sourceToHostV1.js +132 -0
- package/dist/scripts/sourceToHostV1.js.map +1 -0
- package/dist/src/connectors/AppSourceConfigStore.d.ts +17 -3
- package/dist/src/connectors/AppSourceConfigStore.d.ts.map +1 -1
- package/dist/src/connectors/AppSourceConfigStore.js +46 -6
- package/dist/src/connectors/AppSourceConfigStore.js.map +1 -1
- package/dist/src/connectors/HostConnector.d.ts +201 -0
- package/dist/src/connectors/HostConnector.d.ts.map +1 -0
- package/dist/src/connectors/HostConnector.js +903 -0
- package/dist/src/connectors/HostConnector.js.map +1 -0
- package/dist/src/connectors/inProcessTransport.d.ts +131 -0
- package/dist/src/connectors/inProcessTransport.d.ts.map +1 -0
- package/dist/src/connectors/inProcessTransport.js +447 -0
- package/dist/src/connectors/inProcessTransport.js.map +1 -0
- package/dist/src/domain/access/callerPermissions.d.ts +29 -0
- package/dist/src/domain/access/callerPermissions.d.ts.map +1 -1
- package/dist/src/domain/access/callerPermissions.js +85 -5
- package/dist/src/domain/access/callerPermissions.js.map +1 -1
- package/dist/src/domain/access/nativeLocalFence.d.ts +65 -0
- package/dist/src/domain/access/nativeLocalFence.d.ts.map +1 -0
- package/dist/src/domain/access/nativeLocalFence.js +171 -0
- package/dist/src/domain/access/nativeLocalFence.js.map +1 -0
- package/dist/src/domain/access/uriPermission.js +3 -3
- package/dist/src/domain/access/uriPermission.js.map +1 -1
- package/dist/src/domain/byteRange.d.ts +15 -0
- package/dist/src/domain/byteRange.d.ts.map +1 -0
- package/dist/src/domain/byteRange.js +30 -0
- package/dist/src/domain/byteRange.js.map +1 -0
- package/dist/src/domain/defaultPermissions.d.ts.map +1 -1
- package/dist/src/domain/defaultPermissions.js +29 -0
- package/dist/src/domain/defaultPermissions.js.map +1 -1
- package/dist/src/domain/mime.d.ts +8 -16
- package/dist/src/domain/mime.d.ts.map +1 -1
- package/dist/src/domain/mime.js +10 -99
- package/dist/src/domain/mime.js.map +1 -1
- package/dist/src/domain/paths.d.ts.map +1 -1
- package/dist/src/domain/paths.js +5 -3
- package/dist/src/domain/paths.js.map +1 -1
- package/dist/src/domain/sourceConfig.d.ts +52 -19
- package/dist/src/domain/sourceConfig.d.ts.map +1 -1
- package/dist/src/domain/sourceConfig.js +103 -19
- package/dist/src/domain/sourceConfig.js.map +1 -1
- package/dist/src/domain/sourcePackages.d.ts +8 -8
- package/dist/src/domain/sourcePackages.d.ts.map +1 -1
- package/dist/src/domain/sourceRootPair.d.ts +88 -0
- package/dist/src/domain/sourceRootPair.d.ts.map +1 -0
- package/dist/src/domain/sourceRootPair.js +108 -0
- package/dist/src/domain/sourceRootPair.js.map +1 -0
- package/dist/src/domain/syncTypes.d.ts +8 -1
- package/dist/src/domain/syncTypes.d.ts.map +1 -1
- package/dist/src/domain/syncTypes.js +1 -0
- package/dist/src/domain/syncTypes.js.map +1 -1
- package/dist/src/domain/types.d.ts +24 -1
- package/dist/src/domain/types.d.ts.map +1 -1
- package/dist/src/domain/uri.d.ts.map +1 -1
- package/dist/src/domain/uri.js +3 -2
- package/dist/src/domain/uri.js.map +1 -1
- package/dist/src/embeddings/clients/GeminiEmbedder.d.ts.map +1 -1
- package/dist/src/embeddings/clients/GeminiEmbedder.js +2 -5
- package/dist/src/embeddings/clients/GeminiEmbedder.js.map +1 -1
- package/dist/src/embeddings/clients/OpenAIEmbedder.d.ts.map +1 -1
- package/dist/src/embeddings/clients/OpenAIEmbedder.js +2 -3
- package/dist/src/embeddings/clients/OpenAIEmbedder.js.map +1 -1
- package/dist/src/embeddings/clients/QwenEmbedder.d.ts +2 -0
- package/dist/src/embeddings/clients/QwenEmbedder.d.ts.map +1 -1
- package/dist/src/embeddings/clients/QwenEmbedder.js +10 -2
- package/dist/src/embeddings/clients/QwenEmbedder.js.map +1 -1
- package/dist/src/embeddings/clients/VoyageEmbedder.d.ts +2 -0
- package/dist/src/embeddings/clients/VoyageEmbedder.d.ts.map +1 -1
- package/dist/src/embeddings/clients/VoyageEmbedder.js +8 -1
- package/dist/src/embeddings/clients/VoyageEmbedder.js.map +1 -1
- package/dist/src/embeddings/factory.d.ts +5 -3
- package/dist/src/embeddings/factory.d.ts.map +1 -1
- package/dist/src/embeddings/factory.js +7 -3
- package/dist/src/embeddings/factory.js.map +1 -1
- package/dist/src/embeddings/models.d.ts +1 -1
- package/dist/src/embeddings/models.d.ts.map +1 -1
- package/dist/src/embeddings/retry.js +1 -1
- package/dist/src/embeddings/retry.js.map +1 -1
- package/dist/src/embeddings/types.d.ts +6 -0
- package/dist/src/embeddings/types.d.ts.map +1 -1
- package/dist/src/embeddings/types.js +11 -0
- package/dist/src/embeddings/types.js.map +1 -1
- package/dist/src/git/GitRunner.d.ts +110 -30
- package/dist/src/git/GitRunner.d.ts.map +1 -1
- package/dist/src/git/GitRunner.js +511 -199
- package/dist/src/git/GitRunner.js.map +1 -1
- package/dist/src/git/GitWatchRegistry.d.ts +41 -35
- package/dist/src/git/GitWatchRegistry.d.ts.map +1 -1
- package/dist/src/git/GitWatchRegistry.js +61 -79
- package/dist/src/git/GitWatchRegistry.js.map +1 -1
- package/dist/src/git/gitPlace.d.ts +61 -0
- package/dist/src/git/gitPlace.d.ts.map +1 -0
- package/dist/src/git/gitPlace.js +74 -0
- package/dist/src/git/gitPlace.js.map +1 -0
- package/dist/src/git/sourceGitControl.d.ts +31 -19
- package/dist/src/git/sourceGitControl.d.ts.map +1 -1
- package/dist/src/git/sourceGitControl.js +208 -92
- package/dist/src/git/sourceGitControl.js.map +1 -1
- package/dist/src/git/sourceGitStatus.js +1 -1
- package/dist/src/git/sourceGitStatus.js.map +1 -1
- package/dist/src/git/untrackedStats.js +1 -1
- package/dist/src/git/untrackedStats.js.map +1 -1
- package/dist/src/index.d.ts +2 -1
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/index.js +2 -1
- package/dist/src/index.js.map +1 -1
- package/dist/src/lifecycle.d.ts +8 -11
- package/dist/src/lifecycle.d.ts.map +1 -1
- package/dist/src/lifecycle.js +2 -1
- package/dist/src/lifecycle.js.map +1 -1
- package/dist/src/routes/git.d.ts.map +1 -1
- package/dist/src/routes/git.js +183 -54
- package/dist/src/routes/git.js.map +1 -1
- package/dist/src/routes/helpers/uriGuard.d.ts +1 -1
- package/dist/src/routes/helpers/uriGuard.d.ts.map +1 -1
- package/dist/src/routes/helpers/uriGuard.js +3 -2
- package/dist/src/routes/helpers/uriGuard.js.map +1 -1
- package/dist/src/routes/helpers.d.ts +10 -3
- package/dist/src/routes/helpers.d.ts.map +1 -1
- package/dist/src/routes/helpers.js +12 -5
- package/dist/src/routes/helpers.js.map +1 -1
- package/dist/src/routes/list.d.ts.map +1 -1
- package/dist/src/routes/list.js +2 -3
- package/dist/src/routes/list.js.map +1 -1
- package/dist/src/routes/policies.d.ts +6 -4
- package/dist/src/routes/policies.d.ts.map +1 -1
- package/dist/src/routes/policies.js +22 -16
- package/dist/src/routes/policies.js.map +1 -1
- package/dist/src/routes/raw.d.ts.map +1 -1
- package/dist/src/routes/raw.js +65 -11
- package/dist/src/routes/raw.js.map +1 -1
- package/dist/src/routes/sources.d.ts +60 -18
- package/dist/src/routes/sources.d.ts.map +1 -1
- package/dist/src/routes/sources.js +411 -299
- package/dist/src/routes/sources.js.map +1 -1
- package/dist/src/services/BridgeService.d.ts +15 -35
- package/dist/src/services/BridgeService.d.ts.map +1 -1
- package/dist/src/services/BridgeService.js +30 -88
- package/dist/src/services/BridgeService.js.map +1 -1
- package/dist/src/services/FilesystemService.d.ts +3 -2
- package/dist/src/services/FilesystemService.d.ts.map +1 -1
- package/dist/src/services/FilesystemService.js +110 -32
- package/dist/src/services/FilesystemService.js.map +1 -1
- package/dist/src/services/FilesystemUiService.d.ts +4 -1
- package/dist/src/services/FilesystemUiService.d.ts.map +1 -1
- package/dist/src/services/FilesystemUiService.js +66 -25
- package/dist/src/services/FilesystemUiService.js.map +1 -1
- package/dist/src/services/SyncScheduler.d.ts +12 -4
- package/dist/src/services/SyncScheduler.d.ts.map +1 -1
- package/dist/src/services/SyncScheduler.js +37 -8
- package/dist/src/services/SyncScheduler.js.map +1 -1
- package/dist/src/services/baselineRepair.d.ts +13 -3
- package/dist/src/services/baselineRepair.d.ts.map +1 -1
- package/dist/src/services/baselineRepair.js +13 -3
- package/dist/src/services/baselineRepair.js.map +1 -1
- package/dist/src/services/declaredSources.d.ts +125 -42
- package/dist/src/services/declaredSources.d.ts.map +1 -1
- package/dist/src/services/declaredSources.js +117 -45
- package/dist/src/services/declaredSources.js.map +1 -1
- package/dist/src/store/dataFormats.d.ts +17 -2
- package/dist/src/store/dataFormats.d.ts.map +1 -1
- package/dist/src/store/dataFormats.js +18 -3
- package/dist/src/store/dataFormats.js.map +1 -1
- package/dist/src/sync/DeltaSyncRunner.d.ts.map +1 -1
- package/dist/src/sync/DeltaSyncRunner.js +144 -4
- package/dist/src/sync/DeltaSyncRunner.js.map +1 -1
- package/dist/src/sync/SyncJobQueue.d.ts +7 -2
- package/dist/src/sync/SyncJobQueue.d.ts.map +1 -1
- package/dist/src/sync/SyncJobQueue.js +16 -10
- package/dist/src/sync/SyncJobQueue.js.map +1 -1
- package/dist/src/sync/SyncWatchService.d.ts +21 -4
- package/dist/src/sync/SyncWatchService.d.ts.map +1 -1
- package/dist/src/sync/SyncWatchService.js +115 -10
- package/dist/src/sync/SyncWatchService.js.map +1 -1
- package/dist/src/sync/categoryInference.d.ts +1 -1
- package/dist/src/sync/categoryInference.js +1 -1
- package/dist/src/usecases/admitSourceRoot.d.ts +65 -0
- package/dist/src/usecases/admitSourceRoot.d.ts.map +1 -0
- package/dist/src/usecases/admitSourceRoot.js +85 -0
- package/dist/src/usecases/admitSourceRoot.js.map +1 -0
- package/dist/src/usecases/browseSourceFolders.d.ts +85 -0
- package/dist/src/usecases/browseSourceFolders.d.ts.map +1 -0
- package/dist/src/usecases/browseSourceFolders.js +210 -0
- package/dist/src/usecases/browseSourceFolders.js.map +1 -0
- package/dist/src/usecases/createDeclaredSources.d.ts +13 -2
- package/dist/src/usecases/createDeclaredSources.d.ts.map +1 -1
- package/dist/src/usecases/createDeclaredSources.js +39 -0
- package/dist/src/usecases/createDeclaredSources.js.map +1 -1
- package/dist/src/usecases/list.d.ts.map +1 -1
- package/dist/src/usecases/list.js +83 -26
- package/dist/src/usecases/list.js.map +1 -1
- package/dist/src/usecases/listAttachableDevices.d.ts +13 -0
- package/dist/src/usecases/listAttachableDevices.d.ts.map +1 -0
- package/dist/src/usecases/listAttachableDevices.js +10 -0
- package/dist/src/usecases/listAttachableDevices.js.map +1 -0
- package/dist/src/usecases/listSourcePackages.d.ts.map +1 -1
- package/dist/src/usecases/listSourcePackages.js +2 -5
- package/dist/src/usecases/listSourcePackages.js.map +1 -1
- package/dist/src/usecases/purgeExcludedPoints.d.ts.map +1 -1
- package/dist/src/usecases/purgeExcludedPoints.js +3 -2
- package/dist/src/usecases/purgeExcludedPoints.js.map +1 -1
- package/dist/src/usecases/readFiles.d.ts.map +1 -1
- package/dist/src/usecases/readFiles.js +15 -0
- package/dist/src/usecases/readFiles.js.map +1 -1
- package/dist/src/usecases/reconcileSourcePackageRoots.d.ts +1 -1
- package/dist/src/usecases/reconcileSourcePackageRoots.d.ts.map +1 -1
- package/dist/src/usecases/reconcileSourcePackageRoots.js +2 -1
- package/dist/src/usecases/reconcileSourcePackageRoots.js.map +1 -1
- package/dist/src/usecases/revokePrincipal.d.ts +7 -5
- package/dist/src/usecases/revokePrincipal.d.ts.map +1 -1
- package/dist/src/usecases/revokePrincipal.js +29 -7
- package/dist/src/usecases/revokePrincipal.js.map +1 -1
- package/dist/src/usecases/scheduleSourceSync.d.ts +7 -0
- package/dist/src/usecases/scheduleSourceSync.d.ts.map +1 -1
- package/dist/src/usecases/scheduleSourceSync.js +6 -5
- package/dist/src/usecases/scheduleSourceSync.js.map +1 -1
- package/dist/src/usecases/triggerSourceSync.d.ts +46 -0
- package/dist/src/usecases/triggerSourceSync.d.ts.map +1 -0
- package/dist/src/usecases/triggerSourceSync.js +75 -0
- package/dist/src/usecases/triggerSourceSync.js.map +1 -0
- package/dist/src/usecases/uploadBinary.d.ts +2 -1
- package/dist/src/usecases/uploadBinary.d.ts.map +1 -1
- package/dist/src/usecases/uploadBinary.js +2 -2
- package/dist/src/usecases/uploadBinary.js.map +1 -1
- package/dist/src/usecases/vector/endpointGuard.d.ts +1 -1
- package/dist/src/usecases/vector/endpointGuard.js +1 -1
- package/dist/src/vector/qdrantClient.d.ts +1 -1
- package/dist/src/vector/qdrantClient.js +1 -1
- package/dist/src/wiring.d.ts +3 -0
- package/dist/src/wiring.d.ts.map +1 -1
- package/dist/src/wiring.js +72 -6
- package/dist/src/wiring.js.map +1 -1
- package/package.json +145 -54
- package/skills/connect-business-data/SKILL.md +2 -2
- package/skills/create-package/SKILL.md +18 -18
- package/skills/create-package/references/config-and-credentials.md +16 -13
- package/skills/create-package/references/connectors-and-uri-policies.md +36 -27
- package/skills/create-package/references/manifest-and-discovery.md +12 -12
- package/skills/create-package/references/runtime-and-build.md +18 -18
- package/skills/create-package/references/skills-and-context.md +35 -19
- package/skills/create-package/references/surfaces-and-design.md +16 -16
- package/skills/create-package/references/team-and-workflows.md +2 -2
- package/skills/create-package/references/test-and-ship.md +17 -17
- package/skills/create-package/references/tools-and-schemas.md +5 -5
- package/skills/create-package/scripts/{check-package.sh → check-package.mjs} +78 -64
- package/skills/create-package/scripts/{verify-loaded.sh → verify-loaded.mjs} +156 -162
- package/skills/git/SKILL.md +31 -29
- package/skills/manage-files/SKILL.md +11 -14
- package/skills/manage-sources/SKILL.md +85 -45
- package/skills/manage-uri-policy/SKILL.md +9 -6
- package/skills/sync/SKILL.md +1 -1
- package/dist/src/connectors/LocalDiskConnector.d.ts +0 -171
- package/dist/src/connectors/LocalDiskConnector.d.ts.map +0 -1
- package/dist/src/connectors/LocalDiskConnector.js +0 -1233
- package/dist/src/connectors/LocalDiskConnector.js.map +0 -1
- package/skills/manage-files/scripts/copy.sh +0 -7
- package/skills/manage-files/scripts/create.sh +0 -7
- package/skills/manage-files/scripts/mkdir.sh +0 -7
- package/skills/manage-files/scripts/modify.sh +0 -7
- package/skills/manage-files/scripts/upload.sh +0 -16
- package/skills/manage-files/scripts/write.sh +0 -29
- package/skills/manage-sources/scripts/reembed.sh +0 -23
package/skills/git/SKILL.md
CHANGED
|
@@ -7,7 +7,7 @@ requiredFeatures: [files.read]
|
|
|
7
7
|
|
|
8
8
|
# Git
|
|
9
9
|
|
|
10
|
-
Drive git on a **git-backed source** (any
|
|
10
|
+
Drive git on a **git-backed source** (any folder that is a git checkout — on this server, or on a paired device, where git runs on that device for its owner or for a member it admits; fetch/pull/push of a device folder run only for the device's owner, with their own git credentials there — anyone else gets `git_remote_owner_only`)
|
|
11
11
|
through brain-core's governed git routes. These are the **same routes the Git Control
|
|
12
12
|
panel drives**, so an agent gets exactly the rights a human member has: gated by
|
|
13
13
|
`files.read` / `files.write` + the source's uri-policy, with a **server-side snapshot
|
|
@@ -17,7 +17,7 @@ resolved server-side and never touches the agent shell).
|
|
|
17
17
|
Call them with `neuralis request <GET|POST> @neuralis/brain-core/git/<route> …` — inside an
|
|
18
18
|
activated skill it authenticates with the per-stream session ticket, on your own machine with
|
|
19
19
|
`neuralis login`; never with a git credential (fetch/pull/push resolve the remote token
|
|
20
|
-
server-side). The method is part of every call line: `commit` and `branch` READ on GET and
|
|
20
|
+
server-side, or — on a device folder — use its owner's own git credentials there). The method is part of every call line: `commit` and `branch` READ on GET and
|
|
21
21
|
WRITE on POST. This is *not* about committing to the Neuralis repo itself — it is about an
|
|
22
22
|
agent operating git on a user's source.
|
|
23
23
|
|
|
@@ -31,8 +31,8 @@ agent operating git on a user's source.
|
|
|
31
31
|
|
|
32
32
|
Default to **A** for governed local ops and for pushing/pulling your connected remote; **B**
|
|
33
33
|
for platform collaboration; **C** for a fast read or when a user's own skill already drives git.
|
|
34
|
-
Plane A is always "call the routes with `neuralis request`" — the
|
|
35
|
-
`<packages>` overview is metadata; there are no
|
|
34
|
+
Plane A is always "call the routes with `neuralis request`" — the native `git` connector shown in the
|
|
35
|
+
`<packages>` overview is metadata; there are no native git MCP *tools* to call.
|
|
36
36
|
|
|
37
37
|
## Routes covered
|
|
38
38
|
|
|
@@ -54,12 +54,11 @@ source and fence the rest with path policy, or split the subtree into its own re
|
|
|
54
54
|
raw-CLI workaround.
|
|
55
55
|
|
|
56
56
|
**But the refusal is only LOUD on the write side, and this has already fooled a run.** A write
|
|
57
|
-
route answers a scrubbed **`400 git_outside_source`**.
|
|
58
|
-
`
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
with
|
|
62
|
-
source with no `.git` at all. (`commit`, `outgoing` and `show` are honest — they answer a typed
|
|
57
|
+
route answers a scrubbed **`400 git_outside_source`**. Three root-gated summary READS —
|
|
58
|
+
`branch`, `log`, `log-stats` — **fail SOFT**: they answer `200 {"ok":true, …}` with an empty
|
|
59
|
+
payload (`branch` → `branches:[]`; `log` → `commits:[]`; `log-stats` → `stats:{}`), which is
|
|
60
|
+
**byte-identical to a clean repository with nothing to report**. The same empty answer covers a
|
|
61
|
+
source with no `.git` at all. (`status`, `commit`, `outgoing` and `show` are honest — they answer a typed
|
|
63
62
|
`{"ok":false,"code":"unavailable"}` — and `diff` returns an empty diff string, except when it
|
|
64
63
|
refuses a huge read with its own typed `{"ok":false,"code":"too_large"}`. Both of those typed
|
|
65
64
|
refusals arrive on a **200**, so `neuralis request` exits 0: a zero exit with `ok:false` is a
|
|
@@ -67,19 +66,17 @@ soft answer, a non-zero exit is an HTTP refusal whose body and `HTTP <code>` are
|
|
|
67
66
|
EVERY refusal carries `error`; a write-op failure and the three remote 409s also carry
|
|
68
67
|
`ok:false` and `code`; a 403 carries `code` (`feature_denied` / `uri_policy_denied`).)
|
|
69
68
|
|
|
70
|
-
**So an empty read is never evidence of a clean tree
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
mean a clean tree. When you have already read an empty `status` and cannot re-ask, say the plane was
|
|
82
|
-
unreadable; never write "no changes" into a report you cannot back.
|
|
69
|
+
**So an empty `branch`/`log`/`log-stats` read is never evidence of a clean tree — `status` is.**
|
|
70
|
+
`{"ok":true,…}` from `status` proves git ran on that checkout, so empty buckets there mean a clean
|
|
71
|
+
tree; `{"ok":false,"code":"unavailable"}` means git could not read it (no checkout at that root, the
|
|
72
|
+
containment refusal above, or git failing there) — report the git plane **UNKNOWN**. Do not test
|
|
73
|
+
with `branch:null`: a real repository on a detached HEAD, or freshly initialised with no commit
|
|
74
|
+
yet, reports exactly that. **Ask `repos` first** to find the checkout. `{"ok":true,"repos":[]}`
|
|
75
|
+
means there is no checkout at the source root and none one level down. Rows carry `rel`, and only
|
|
76
|
+
a row with `rel:""` is the SOURCE ROOT — any other `rel` is a nested checkout that answers only
|
|
77
|
+
when you pass `repo=<rel>`. A `rel:""` row only proves a `.git` is THERE, not that git accepted it
|
|
78
|
+
— the containment refusal keeps its row, so `status` stays the confirmation. Never write "no
|
|
79
|
+
changes" into a report you cannot back.
|
|
83
80
|
|
|
84
81
|
| Action | Method | Route | Key params | Gate |
|
|
85
82
|
|---|---|---|---|---|
|
|
@@ -91,7 +88,7 @@ unreadable; never write "no changes" into a report you cannot back.
|
|
|
91
88
|
| Per-commit `+/-` totals for a log page | GET | `log-stats` | `source`,`maxCount?`,`skip?`,`ref?` | `files.read` + `read` (root) |
|
|
92
89
|
| Files a commit changed | GET | `commit` | `source`,`sha=<sha>` | `files.read` + `read` (root) |
|
|
93
90
|
| Committed-but-not-pushed files | GET | `outgoing` | `source` | `files.read` + `read` (root) |
|
|
94
|
-
| In-source repo picker — **
|
|
91
|
+
| In-source repo picker — **empty `repos` ⇒ no checkout at the root or one level down** | GET | `repos` | `source` | `files.read` + `read` (root) |
|
|
95
92
|
| Stage whole files or a hunk | POST | `stage` | `source`,`paths:[…]` **or** `hunk:"<patch>"` | `files.write` + `write` (per-path) |
|
|
96
93
|
| Unstage whole files or a hunk | POST | `unstage` | `source`,`paths:[…]` **or** `hunk` | `files.write` + `write` (per-path) |
|
|
97
94
|
| Discard working-tree changes (**destructive** → returns `rescue`) | POST | `discard` | `source`,`paths:[…]` | `files.write` + `write` (per-path) |
|
|
@@ -136,7 +133,12 @@ The remote routes act as *you*: they read your own remote binding and resolve yo
|
|
|
136
133
|
via the agent-core **git-connect** surface (feature `git.connect`) — the **Git Remotes** config
|
|
137
134
|
card — with either a Personal Access Token or **GitHub OAuth**. Only `origin` over HTTPS is
|
|
138
135
|
supported (SSH → 409). If a push/pull returns `not_connected` / `no_credential`, ask the user to
|
|
139
|
-
connect the remote in that card first.
|
|
136
|
+
connect the remote in that card first. On a **device folder** no binding is used: the device's
|
|
137
|
+
owner fetches/pulls/pushes with their own git credentials on that machine; for anyone else the
|
|
138
|
+
route answers 409 `git_remote_owner_only` — ask the owner to run it. Any git call on a device
|
|
139
|
+
folder that answers 409 `git_device_unavailable` names why in `reason` (`devices_disabled`,
|
|
140
|
+
`runtime_offline`, `broker_outdated`, `others_denied`, `device_not_ready` — the device's broker is not
|
|
141
|
+
ready; its owner runs `neuralis device status` there, …) — report it; it is not an empty repo.
|
|
140
142
|
|
|
141
143
|
## Safe workflow
|
|
142
144
|
|
|
@@ -179,15 +181,15 @@ neuralis request GET @neuralis/brain-core/git/log -f source=my-repo -f maxCou
|
|
|
179
181
|
# authorship, and is unsafe once it has been pushed (the remote keeps the original
|
|
180
182
|
# and the two histories diverge). Stage NAMED paths only — `paths:[…]` is what keeps
|
|
181
183
|
# a stray secret from being swept in; there is no route that un-commits.
|
|
182
|
-
|
|
183
|
-
|
|
184
|
+
echo '{"source":"my-repo","paths":["src/app.ts","README.md"]}' | neuralis request POST @neuralis/brain-core/git/stage --input -
|
|
185
|
+
echo '{"source":"my-repo","message":"Fix null guard in loader"}' | neuralis request POST @neuralis/brain-core/git/commit --input -
|
|
184
186
|
|
|
185
187
|
# Create a branch, then switch to it.
|
|
186
188
|
# checkout MOVES HEAD and swaps the working tree to that branch's content — the files
|
|
187
189
|
# the user is looking at change under them. It is plain (never `-f`): if the switch
|
|
188
190
|
# would overwrite uncommitted local changes, git refuses and you get a 409. Report
|
|
189
191
|
# that refusal; there is no force option here and you must not build one in Plane C.
|
|
190
|
-
|
|
192
|
+
echo '{"source":"my-repo","action":"create","name":"fix/loader"}' | neuralis request POST @neuralis/brain-core/git/branch --input -
|
|
191
193
|
neuralis request POST @neuralis/brain-core/git/checkout -f source=my-repo -f ref=fix/loader
|
|
192
194
|
|
|
193
195
|
# Sync a connected remote (needs uri-policy exec + a connected remote).
|
|
@@ -202,5 +204,5 @@ neuralis request POST @neuralis/brain-core/git/pull -f source=my-repo
|
|
|
202
204
|
neuralis request POST @neuralis/brain-core/git/push -f source=my-repo
|
|
203
205
|
|
|
204
206
|
# Nested repo inside a multi-repo source: add the repo selector
|
|
205
|
-
neuralis request GET @neuralis/brain-core/git/status -f source=mono -f repo=
|
|
207
|
+
neuralis request GET @neuralis/brain-core/git/status -f source=mono -f repo=api
|
|
206
208
|
```
|
|
@@ -12,7 +12,7 @@ The `fs_*` tools (`fs_read`, `fs_write`, etc.) remain the primary path for one-o
|
|
|
12
12
|
file operations — this skill is for *bulk*: iterating with a shell loop, posting a
|
|
13
13
|
batch, or scripting an `upload + approve` sequence end-to-end. Call the routes with
|
|
14
14
|
`neuralis request` (the session ticket inside an activated skill, `neuralis login`
|
|
15
|
-
on your own machine)
|
|
15
|
+
on your own machine) — every route is one call line, with no script in between.
|
|
16
16
|
|
|
17
17
|
## Routes covered
|
|
18
18
|
|
|
@@ -22,8 +22,8 @@ on your own machine); `write` and `upload` go through their scripts.
|
|
|
22
22
|
| Search vector index | POST | `search` | `files.search` |
|
|
23
23
|
| Read multiple files | POST | `read` | `files.read` |
|
|
24
24
|
| Raw (un-summarized) read | GET | `raw` | `files.read` |
|
|
25
|
-
| Write — every verb (create / overwrite / edit / insert / lines / fields / move / copy / mkdir / revert / delete) | POST | `write`
|
|
26
|
-
| Upload a payload (multipart/form-data) | POST | `upload`
|
|
25
|
+
| Write — every verb (create / overwrite / edit / insert / lines / fields / move / copy / mkdir / revert / delete) | POST | `write` | `files.write` |
|
|
26
|
+
| Upload a payload (multipart/form-data) | POST | `upload` | `files.write` |
|
|
27
27
|
| Approve a pending change | POST | `approve` | `files.write` |
|
|
28
28
|
| List pending changes (project-wide) | GET | `pending` | `files.read` |
|
|
29
29
|
|
|
@@ -37,13 +37,12 @@ server-side **403** from `search` even though the other routes work.
|
|
|
37
37
|
|
|
38
38
|
## Bodies
|
|
39
39
|
|
|
40
|
-
- `list` / `search` / `read` / `approve` take a JSON body (
|
|
41
|
-
|
|
42
|
-
- `/write` body = `{"agentId":"…","uri":"data://notes/plan.md","<verb>":…}` — the VERB is a KEY and its presence is the intent. Content verbs COMPOSE in one call, in a fixed order, as ONE write with ONE baseline: `create` (`{content, client_request_id?}` — never overwrites; a taken name lands BESIDE as `name-2.ext` and the response `uri` is where it went, so read it back), `overwrite` (`{content}` — refuses on a missing file and names `create`), `edit` (`[{old_string, new_string?, replace_all?, expected_replacements?}]`, applied in order, one failure discards all of them), `insert` (`{insert_text, insert_line?}` — inserts AFTER that line, `0` = start of file, omitted = append), `lines` (`{line_start, line_end, content}`), `fields` (`{category, status, pinned, tags{add,remove,set}, metadata}`). Structural verbs stand ALONE: `move`/`copy` (a destination uri or, for a file move, a bare new filename; `copy` may cross sources), `mkdir:true` (a real empty directory; not on `brain://`, where folders are implicit), `revert:true` (one-level undo), `delete:true` (a file, or a whole folder recursively). **A 2xx does not mean success** — a refusal is 200 with `ok:false`, so branch on `ok`. A `move` (or a `revert` that relocates or re-creates) onto a uri that already holds something answers `ok:false` + `error:"DESTINATION_EXISTS"` — nothing was overwritten; delete or rename the occupant first. A delete has ONE spelling, the `delete` key: `fields.status:"deleted"` is refused. `review` is never read from the body — a content edit (`overwrite`/`edit`/`insert`/`lines`) lands `pending_review` on every lane (visible and revertible in Changes); `create`/`move`/`copy`/`mkdir` land committed for a human interactive caller and `pending_review` from this ticket lane; `/upload` also journals agent-origin uploads as pending review; interactive human uploads land committed. Use `/write` for JSON text and `/upload` for multipart file bytes. A missing `agentId`/`uri` is a **400** naming the field, a body the server could not parse a **400** `Request body must be a JSON object`. A uri-policy denial is a **403 with no `ok` field**, a disabled source a **409** with `code:"source_disabled"`. A source slug this project does not have answers one of two ways, and BOTH mean "stop guessing this name": with a scheme (`zzz://a.md`) the uri gate answers **403 `uri_policy_denied`** first; without one (`notes.md`) you get **404 `code:"source_not_configured"`** carrying `availableSources` — the sources you CAN address. `/list` gives the 404 in both forms. Switch to a source from that list (or from `<runtime_stack>`); retrying the same name never works. `/read` is different again: it reports PER FILE inside a 200, so a denied or disabled source arrives as `{uri, error, code:"forbidden"}` — never a 409 — and a missing file as `code:"not_found"`. No code means the read failed for some other reason; do not conclude the file is gone. A folder delete or copy that partly succeeded reports what really happened: `affected` (files touched) and `failed` (the NAMES that could not be), so "failed" does not mean "nothing happened". `warning:"moved_with_source_retained"` on a move means the copy landed but the original could not be removed — BOTH copies exist on purpose; do not re-run the move. `indexed:false` means the bytes DID land and are readable, but search indexing was skipped or failed; report it, do not re-write. Sync retries failed indexing only for eligible files; excluded files remain unindexed. A non-2xx prints the route's body too — on stderr, followed by an `HTTP <code>` line, under a `--- stderr ---` separator, so read the whole output.
|
|
40
|
+
- `list` / `search` / `read` / `approve` / `write` take a JSON body on stdin (`echo '<json>' | neuralis request POST @neuralis/brain-core/<route> --input -`, the one form bash and PowerShell both parse; a `'` inside the text is written `\u0027` in the JSON); file content and other free text ride that body, never a `-f` argument (PowerShell strips the quotes inside an argument).
|
|
41
|
+
- `/write` body = `{"agentId":"…","uri":"data://notes/plan.md","<verb>":…}` — the VERB is a KEY and its presence is the intent. Content verbs COMPOSE in one call, in a fixed order, as ONE write with ONE baseline: `create` (`{content, client_request_id?}` — never overwrites; a taken name lands BESIDE as `name-2.ext` and the response `uri` is where it went, so read it back), `overwrite` (`{content}` — refuses on a missing file and names `create`), `edit` (`[{old_string, new_string?, replace_all?, expected_replacements?}]`, applied in order, one failure discards all of them), `insert` (`{insert_text, insert_line?}` — inserts AFTER that line, `0` = start of file, omitted = append), `lines` (`{line_start, line_end, content}`), `fields` (`{category, status, pinned, tags{add,remove,set}, metadata}`). Structural verbs stand ALONE: `move`/`copy` (a destination uri or, for a file move, a bare new filename; `copy` may cross sources), `mkdir:true` (a real empty directory; not on `brain://`, where folders are implicit), `revert:true` (one-level undo), `delete:true` (a file, or a whole folder recursively). **A 2xx does not mean success** — a refusal is 200 with `ok:false` and the CLI exits 0, so branch on `ok`, never the status or the exit code. A `move` (or a `revert` that relocates or re-creates) onto a uri that already holds something answers `ok:false` + `error:"DESTINATION_EXISTS"` — nothing was overwritten; delete or rename the occupant first. A delete has ONE spelling, the `delete` key: `fields.status:"deleted"` is refused. `review` is never read from the body — a content edit (`overwrite`/`edit`/`insert`/`lines`) lands `pending_review` on every lane (visible and revertible in Changes); `create`/`move`/`copy`/`mkdir` land committed for a human interactive caller and `pending_review` from this ticket lane; `/upload` also journals agent-origin uploads as pending review; interactive human uploads land committed. Use `/write` for JSON text and `/upload` for multipart file bytes. A missing `agentId`/`uri` is a **400** naming the field, a body the server could not parse a **400** `Request body must be a JSON object`. A uri-policy denial is a **403 with no `ok` field**, a disabled source a **409** with `code:"source_disabled"`. A source slug this project does not have answers one of two ways, and BOTH mean "stop guessing this name": with a scheme (`zzz://a.md`) the uri gate answers **403 `uri_policy_denied`** first; without one (`notes.md`) you get **404 `code:"source_not_configured"`** carrying `availableSources` — the sources you CAN address. `/list` gives the 404 in both forms. Switch to a source from that list (or from `<runtime_stack>`); retrying the same name never works. `/read` is different again: it reports PER FILE inside a 200, so a denied or disabled source arrives as `{uri, error, code:"forbidden"}` — never a 409 — a missing file as `code:"not_found"`, and a device folder that cannot serve as `code:"source_unavailable"` or `"device_refused"` with a `reason` (`device_not_ready` adds `not_ready`: what the device's owner fixes there). No code means the read failed for some other reason; do not conclude the file is gone. A folder delete or copy that partly succeeded reports what really happened: `affected` (files touched) and `failed` (the NAMES that could not be), so "failed" does not mean "nothing happened". `warning:"moved_with_source_retained"` on a move means the copy landed but the original could not be removed — BOTH copies exist on purpose; do not re-run the move. `indexed:false` means the bytes DID land and are readable, but search indexing was skipped or failed; report it, do not re-write. Sync retries failed indexing only for eligible files; excluded files remain unindexed. A non-2xx prints the route's body too — on stderr, followed by an `HTTP <code>` line, under a `--- stderr ---` separator, so read the whole output.
|
|
43
42
|
- `/search` body key is `search_mode` (semantic|filter|grep) — the SAME vocabulary as the `fs_search` tool; the legacy `mode` key is rejected with 400. The route forwards `search_mode`, `query`, `folder_uri`, `glob`, `category`, `tags`, `status`, `created_after`/`created_before`, `limit`, and the grep-only `path_glob`, `context` and `case_sensitive`. In `grep` mode the search is uri-policy `read`-gated (only paths the caller holds `read` policy on are grepped), the match is a FIXED STRING, and the answer carries `truncated` + `total_seen` — a cut set says so, so never read a full-looking list as proof that the rest is absent.
|
|
44
43
|
- `/raw` is a GET — pass the file URI as `-f uri=<uri>` and redirect stdout to a file: it always returns the full bytes, unaffected by the response headers; what those headers say is a BROWSER instruction. Safe types (images except SVG, video, audio, PDF, text, JSON) are marked for inline display; SVG, HTML and XML are marked `attachment` so a person clicking the link downloads them instead of executing them on the app origin. Do not describe a `.svg` or `.html` you wrote as viewable in the browser — offer it as a download, or convert it to a raster image if a human needs to look at it.
|
|
45
44
|
- `/read` is at parity with the `fs_read` tool: the body takes `files[]` — each entry a URI string or `{"uri":"…","line_start":N,"line_end":M}` with that file's own window — plus `read_version`, batch-level `line_start`/`line_end` and `include_ids`. An entry that is neither shape is a **400**. Text is a bounded preview; native media may accompany it, while unsupported/invalid binary data has a URI and marker. For a byte-exact binary copy use the authorized `/raw` byte lane and multipart `/upload`, never re-encode a text preview. If you only need the pre-edit content, a plain `/read` response already carries it: each file's `version.baseline.content`, with `available_versions` listing `baseline` exactly when one exists.
|
|
46
|
-
- `/upload` is **multipart/form-data**, NOT JSON —
|
|
45
|
+
- `/upload` is **multipart/form-data**, NOT JSON — `--form file=@<local path>` and `--form agentId=<id>` are required, `--form uri=…` / `--form tags=a,b` optional; a JSON body is rejected with 400. The 200 carries `indexed`: `false` means the bytes DID land but search indexing was skipped by the source selection or failed (provider outage/quota) — report it, do not re-upload. An eligible sync retries failed indexing; excluded uploads remain unindexed until the selection changes. The 200 also carries `mimeType`, and it may differ from what the upload declared: the stored type is resolved from the filename extension first, with the declared value kept only for an extension the platform does not know, and a common-image claim the leading bytes contradict falls back to `application/octet-stream`. Give the file a truthful extension and the stored type follows.
|
|
47
46
|
- `GET /pending` lists durable pending records inside the Changes workspace. `status` (`pending_review`\|`approved`\|`reverted`), `source`, `op` (`create`\|`modify`\|`delete`\|`move`) and `limit` filter the list; owner/scope and URI READ gates apply per record. Review begins with `POST /pending` `{action:"preview",id}`: it returns the current connector content separately from the recorded snapshot and saved baseline, typed missing/unavailable/binary/too-large states, `indexState`, `requiresAcknowledgement`, and `expectedFingerprint`. The preview is bounded by `pendingPreviewMaxBytes`; it never fabricates missing content or vectors. Resolve through `POST /approve` `{id,expectedFingerprint}` or `POST /pending` `{action:"revert"|"dismiss",id,expectedFingerprint}`. If the preview requires acknowledgement, inspect those states and include `acknowledgeCurrentState:true`; never auto-acknowledge an unseen preview. The server rechecks freshness and WRITE authority at apply: a changed fingerprint requires a new preview, and acknowledgement grants no missing permission. Bare legacy `/write revert:true` refuses unsafe pending recovery; ordinary non-pending one-level undo remains available. Approval/dismissal preserve the stored snapshot/index state (including recovery-only or absent index), rather than certifying current connector bytes as indexed. For a file the preview shows `missing` with a saved `journal-latest-write` baseline, an acknowledged approve/dismiss closes the review and the file stays gone; revert is the restore. Terminal retries remain owner-gated and idempotent; `uri` is omitted without current READ and WRITE access. Revert restores the saved baseline and refuses missing baselines or occupied move destinations. Discard/Repair remain orphan-only, owner-gated operations; no transient outage is proof of orphanhood.
|
|
48
47
|
|
|
49
48
|
|
|
@@ -55,14 +54,14 @@ For a disposable pending record you created in your project, substitute its real
|
|
|
55
54
|
|
|
56
55
|
```bash
|
|
57
56
|
neuralis request POST @neuralis/brain-core/pending -f action=preview -f id=<scratch-record-id>
|
|
58
|
-
|
|
57
|
+
echo '{"action":"revert","id":"<scratch-record-id>","expectedFingerprint":"<64-hex-preview-fingerprint>","acknowledgeCurrentState":true}' | neuralis request POST @neuralis/brain-core/pending --input -
|
|
59
58
|
```
|
|
60
59
|
|
|
61
60
|
Pending calls return one page; scan-orphans preserves that page in `changes` and puts its orphan subset in `orphans`/`orphanIds`: pass `cursor` from `nextCursor` unchanged with the same filters, or `uri` for an exact URI. Check `complete`, `partial` and `hasMoreAvailable`; a partial exhausted branch remains incomplete. On `restartRequired`, restart the list instead of retrying the old cursor. Repair returns scannedVisible/orphaned/attempted/discarded/refused/failed/reasons for one batch; continue only via nextCursor; pause on partial and use an explicit Continue available/Retry.
|
|
62
61
|
|
|
63
62
|
```bash
|
|
64
63
|
# Recursive list of /data
|
|
65
|
-
|
|
64
|
+
echo '{"uri":"data://","recursive":true,"limit":100}' | neuralis request POST @neuralis/brain-core/list --input -
|
|
66
65
|
|
|
67
66
|
# Vector search across all sources (body key is `search_mode`, same as the fs_search tool)
|
|
68
67
|
neuralis request POST @neuralis/brain-core/search -f search_mode=semantic -f query='telemetry pipeline' -F limit=10
|
|
@@ -74,15 +73,13 @@ neuralis request GET @neuralis/brain-core/pending -f status=pending_review -f li
|
|
|
74
73
|
neuralis request GET @neuralis/brain-core/raw -f uri=data://report.pdf > /tmp/report.pdf
|
|
75
74
|
|
|
76
75
|
# Create a text file — the journaled write lane. The verb is the KEY.
|
|
77
|
-
# `<agent-id>` is a placeholder; a real id makes this line write for real.
|
|
78
|
-
|
|
79
|
-
bash ${SKILL_DIR}/scripts/write.sh
|
|
76
|
+
# `<agent-id>` is a placeholder; a real id makes this line write for real. Read `ok` in the answer.
|
|
77
|
+
echo '{"agentId":"<agent-id>","uri":"data://scratch/manage-files-probe.md","create":{"content":"# probe\n"}}' | neuralis request POST @neuralis/brain-core/write --input -
|
|
80
78
|
|
|
81
79
|
# Upload a payload (multipart, NOT JSON): file + agentId are required form fields.
|
|
82
80
|
# The route never overwrites: a `URI` already in use lands the upload BESIDE the
|
|
83
81
|
# existing file as `name (2).ext`, and the response `uri` is where it went — read
|
|
84
82
|
# it, do not assume the path. `<agent-id>` is a placeholder; take a real id from the agents
|
|
85
83
|
# list, and note that a real id makes this line write for real.
|
|
86
|
-
|
|
87
|
-
bash ${SKILL_DIR}/scripts/upload.sh
|
|
84
|
+
neuralis request POST @neuralis/brain-core/upload --form file=@/tmp/report.pdf --form agentId=<agent-id> --form uri=data://report.pdf --form tags=reports,q3
|
|
88
85
|
```
|
|
@@ -32,8 +32,10 @@ To just **survey** the configured sources and their freshness (read-only, the
|
|
|
32
32
|
are opt-in: without `include_counts` the registry still lists the sources but
|
|
33
33
|
`on_disk`/`indexed_count`/`unindexed` are usually omitted (survey mode is
|
|
34
34
|
exactly when you want them).
|
|
35
|
-
2. For any source
|
|
36
|
-
|
|
35
|
+
2. For any source that carries `last_error`, report it — it is the per-source
|
|
36
|
+
diagnosis and needs no extra call. `sync_status: "error"` means the last
|
|
37
|
+
SYNC failed; a `last_error` without it means the walk or count failed now
|
|
38
|
+
(no `on_disk`), not the sync. Do **not** reach for the log
|
|
37
39
|
files with `fs_read`: `data://<package>/logs/**` is read-denied by uri policy
|
|
38
40
|
for everyone below owner/admin, so on a member's behalf that call fails.
|
|
39
41
|
Read them through `inspect-agent-core` (or, for the platform-wide view, the
|
|
@@ -61,18 +63,18 @@ server-side source rows rather than the index-count survey.)
|
|
|
61
63
|
| List registered kinds | GET | `sources/kinds` | | `files.read` |
|
|
62
64
|
| Get a kind's config schema | GET | `sources/kinds/<kind>/schema` | | `files.read` |
|
|
63
65
|
| Discoverable connectors (filesystem hints) | GET | `sources/discoverable` | | `sources.mount` |
|
|
64
|
-
| Browse
|
|
66
|
+
| Browse folders before adding one | GET | `sources/browse` | `path`, `device?` | `sources.mount`; with `device` the device's owner (`device.own`) |
|
|
65
67
|
| Create a new source | POST | `sources` | body (below) | `sources.mount` |
|
|
66
68
|
| Update an existing source | PATCH | `sources` | body (below) | `sources.mount` |
|
|
67
69
|
| Delete a source | DELETE | `sources/<slug>[?purge=1]` | | `sources.mount` |
|
|
68
70
|
| Enable / disable a source | POST | `sources/enabled` | `source`, `enabled` (`true`\|`false`\|`"auto"`) | `sources.mount` |
|
|
69
|
-
| Trigger sync (202 + queue job snapshot) | POST | `sources/sync` | `source`, `agentId?` | `sources.sync` |
|
|
71
|
+
| Trigger sync (202 + queue job snapshot) | POST | `sources/sync` | `source`, `agentId?`, `confirmEmpty?` | `sources.sync` |
|
|
70
72
|
| Cancel an in-flight sync | POST | `sources/cancel` | `source?` | `sources.sync` |
|
|
71
73
|
| Job status | GET | `sources/sync-status` | `source?` | `sources.sync` |
|
|
72
74
|
| Forget sync state (next tick re-walks; deletes nothing) | POST | `sources/reset` | `source` | `sources.sync` |
|
|
73
75
|
| Rescan changes (full re-walk now; unchanged files keep their vectors; 202 + job) | POST | `sources/reindex` | `source`, `agentId?` | `sources.sync` |
|
|
74
76
|
| Clean a file / folder / source index (estimate first) | POST | `sources/purge` | body (below) | `sources.mount` + `sources.sync` |
|
|
75
|
-
| Catch up embedding debt
|
|
77
|
+
| Catch up embedding debt, or re-embed with `force` (estimate first) | POST | `sources/reindex` + `embeddingOnly` or `force` (lines under §Re-embed) | `source`, `folder?`/`uri?`, `estimate?` | `sources.sync` |
|
|
76
78
|
|
|
77
79
|
> **`update` takes no `<slug>`.** PATCH targets the bare `sources` path; the
|
|
78
80
|
> source to patch is the body `source` field (the handler ignores the path).
|
|
@@ -99,19 +101,28 @@ feature server-side, beyond the `files.read` floor — a caller holding only
|
|
|
99
101
|
- **`sources.mount`** — create, update, delete, enable/disable, browse and the
|
|
100
102
|
discoverable list. Browsing and the
|
|
101
103
|
discoverable list are the steps that PRECEDE attaching, and they enumerate the
|
|
102
|
-
host: you may browse exactly what you would be allowed to attach.
|
|
104
|
+
host: you may browse exactly what you would be allowed to attach. On a native
|
|
105
|
+
install (no container) a folder on this server may root only in the project's own
|
|
106
|
+
folder — browsable with its parents on the way down to it — or a privileged
|
|
107
|
+
zone below; any other folder answers `403 native_local_root_outside_project`
|
|
108
|
+
and is attached as a folder on the user's own paired device instead.
|
|
103
109
|
- **`sources.privileged`** — browsing the filesystem root or any
|
|
104
110
|
protected host zone (the App Zone, the Neuralis tree), the same zones whose
|
|
105
111
|
ATTACH needs it. A protected directory is also omitted from the listing of a
|
|
106
112
|
parent you may browse, so an absent entry is not proof it does not exist.
|
|
107
|
-
- **`sources.sync`** — sync, cancel, reset, reindex,
|
|
113
|
+
- **`sources.sync`** — sync, cancel, reset, reindex, re-embed, sync-status.
|
|
108
114
|
|
|
109
115
|
The index purge requires both `sources.mount` and `sources.sync`, source-scope management authority and current READ visibility.
|
|
110
116
|
|
|
111
117
|
Create/update/delete/enable additionally enforce `canAccessScope(.., 'write')`
|
|
112
118
|
on the target source's scope, and create validates the kind's scope rules.
|
|
119
|
+
Send a folder's `root` alone: the server derives its `hostRoot` (the same
|
|
120
|
+
folder on the machine) and stores both, so the source opens whether the server runs
|
|
121
|
+
in Docker or natively. A `hostRoot` that contradicts that derivation answers
|
|
122
|
+
`400 source_root_pair_mismatch`; one nothing derives is accepted only from a
|
|
123
|
+
`sources.privileged` caller, and audited.
|
|
113
124
|
|
|
114
|
-
### Privileged and
|
|
125
|
+
### Privileged sources and device folders
|
|
115
126
|
|
|
116
127
|
One escalation sits above `sources.mount`, not granted below the `admin` tier (`admin` holds
|
|
117
128
|
it through its enumerated default grant, `owner` through the `'*'` wildcard; grantable to any
|
|
@@ -122,17 +133,33 @@ custom role):
|
|
|
122
133
|
filesystem (`/`). Containment is checked in both directions on canonical paths, so a
|
|
123
134
|
sub-path or an ancestor of a protected zone is caught too.
|
|
124
135
|
|
|
125
|
-
A
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
136
|
+
A folder is one kind, `host`, on one of two places its stored config names: without
|
|
137
|
+
`connection.config.device` it is a folder on this server; with one it is a folder on that
|
|
138
|
+
paired device (the DEVICE plane), reached through the device's broker. A device folder has one
|
|
139
|
+
rule: **only that device's owner, holding `device.own`, attaches or edits it** — at every
|
|
140
|
+
root, and no role feature replaces it. Anyone else gets 403, whatever they hold. It is
|
|
141
|
+
attached at user scope unless you send `"scope":"project"` (never `agent`), its `root` is an
|
|
142
|
+
absolute path on that device, and the place never changes after the attach — to move a
|
|
143
|
+
folder between this server and a device, delete it and attach it again.
|
|
129
144
|
|
|
130
|
-
A
|
|
145
|
+
A device folder is also bounded by the device's own allowlist, which the platform cannot
|
|
131
146
|
widen: even a permissive source policy only reaches paths the device's owner granted. If a
|
|
132
|
-
|
|
133
|
-
limit — the owner widens it with `neuralis device grant`, not a policy edit.
|
|
134
|
-
|
|
135
|
-
|
|
147
|
+
device read or write fails while the source policy allows it, report the allowlist as the
|
|
148
|
+
limit — the owner widens it with `neuralis device grant`, not a policy edit. The git panel
|
|
149
|
+
and `/git/*` answer for a folder on this server only.
|
|
150
|
+
|
|
151
|
+
To find the folder on your OWN device, browse it: `sources/browse -f device=dev_… -f path=`
|
|
152
|
+
(empty path) lists the folders that device allows this server, with `-f path=/abs/dir` one
|
|
153
|
+
level below. Anyone but the owner gets `403 Only the device's owner may browse it.`, an
|
|
154
|
+
unknown id too. A `200` with `state` other than `ok` and no entries is the device's answer:
|
|
155
|
+
`ceiling_denied` (not allowed yet), `device_offline`, `broker_outdated` (an older CLI there).
|
|
156
|
+
For a folder it does not allow yet, ask the device to record it for its owner — the grant
|
|
157
|
+
stays on that machine (tray → Allow a folder…, or `neuralis device grant <dir>`):
|
|
158
|
+
`neuralis request POST @neuralis/agent-core/devices/dev_…/requests -f path=/abs/dir -f list=read`
|
|
159
|
+
(`list=write` for a writable folder) → `{recorded:true}`, or `{recorded:false,
|
|
160
|
+
reason:"inside_ceiling"}` when it is already allowed.
|
|
161
|
+
|
|
162
|
+
Attaching a device folder is not the same act as granting host command execution: reading
|
|
136
163
|
files through `fs_*` and running commands there are separate grants.
|
|
137
164
|
|
|
138
165
|
The same split holds for every exec-capable source (a virtual desktop, any
|
|
@@ -153,13 +180,15 @@ server-side sync queue. Poll `sources/sync-status` (`-f source=<slug>`) until
|
|
|
153
180
|
with `source` stops one source's job mid-run; without it, EVERY job on
|
|
154
181
|
sources you can see.
|
|
155
182
|
|
|
156
|
-
An embedding job can end `paused`: report `result.embedding.pausedReason` and partial counts. Resume is a new explicitly authorized `
|
|
183
|
+
An embedding job can end `paused`: report `result.embedding.pausedReason` and partial counts. Resume is a new explicitly authorized `embeddingOnly` request, using durable point debt; no saved job ID or automatic paid restart.
|
|
157
184
|
|
|
158
185
|
`sources/sync` refuses in two ways worth telling apart. **404** — the slug does not
|
|
159
186
|
resolve for you (it does not exist, or it is outside your scope; the two answer
|
|
160
187
|
alike on purpose). **400** — the source exists but carries no `sync` block, so
|
|
161
188
|
there is nothing to trigger: add one with an update first. Neither is a server
|
|
162
|
-
fault, so neither should be retried unchanged.
|
|
189
|
+
fault, so neither should be retried unchanged. A job that fails `root_empty`
|
|
190
|
+
(or `root_unreachable`) removed nothing; `confirmEmpty:true` is for a folder the
|
|
191
|
+
user confirmed is empty (the `sync` skill).
|
|
163
192
|
|
|
164
193
|
## Fields, bodies and script env
|
|
165
194
|
|
|
@@ -171,20 +200,20 @@ fault, so neither should be retried unchanged.
|
|
|
171
200
|
- `?purge=1` on delete enqueues an async vector purge. Delete then returns
|
|
172
201
|
**202 + `{purgeJob, …}`** (vs 200 normally). Any delete resolves the source's
|
|
173
202
|
open notifications (its unread failure warnings) for you and its creator.
|
|
174
|
-
-
|
|
175
|
-
source). `
|
|
176
|
-
`
|
|
203
|
+
- The re-embed body takes `source` (required) and `folder` / `uri` — its scope (one of them, inside `source`; neither = the whole
|
|
204
|
+
source). `embeddingOnly:true` catches up debt, `force:true` selects a forced connector re-embed instead, and `estimate:true` on
|
|
205
|
+
either only ESTIMATES. `scope:"platform"` (catch-up only, whole source, needs `platform.vector.maintain`) catches up EVERY
|
|
177
206
|
writer's points of the source, not only yours — the way back after an operator dense clear.
|
|
178
207
|
- Create and update bodies (`--input -`) MUST include
|
|
179
208
|
`source` + `permissions`; create additionally requires `connection.kind`. May also
|
|
180
|
-
carry `
|
|
209
|
+
carry `packageFolders` (an array of folders; absent or `null` = unchanged, so a listing
|
|
181
210
|
round-tripped through jq never 400s on it) — see **Package sources** below. A `sync`
|
|
182
211
|
block may carry an `include` allowlist alongside `exclude`/`trigger`
|
|
183
212
|
(`"sync": {"exclude": [], "include": ["skills/**"], "trigger": "manual"}`): non-empty
|
|
184
213
|
means only matching files sync, and an exclude still wins. A `sync.media` object
|
|
185
214
|
(`{"images":true,"pdf":true,"video":false,"audio":false}`, absent key = that default)
|
|
186
215
|
picks which binary kinds a MULTIMODAL active model embeds; a text-only model embeds
|
|
187
|
-
none, and `lastSyncResult.mediaSkipped` counts what was left out; `lastSyncResult.binarySkipped` is the last count of binary files not indexed as text (a binary extension, or a NUL in the first `brainSyncBinarySniffChars` characters); `lastSyncResult.embeddingDegraded` lists the reasons (`quota`, `credentials`, `rate_limit`, …) when the embedder was unavailable during the pass — the files are indexed and text-searchable, their semantic embedding is owed and caught up by `
|
|
216
|
+
none, and `lastSyncResult.mediaSkipped` counts what was left out; `lastSyncResult.binarySkipped` is the last count of binary files not indexed as text (a binary extension, or a NUL in the first `brainSyncBinarySniffChars` characters); `lastSyncResult.embeddingDegraded` lists the reasons (`quota`, `credentials`, `rate_limit`, …) when the embedder was unavailable during the pass — the files are indexed and text-searchable, their semantic embedding is owed and caught up by an `embeddingOnly` re-embed once the embedder answers. The `invalid` reason is a local PNG structural check before provider work; invalid input preserves existing indexed and recovery payloads. **`include` bounds the
|
|
188
217
|
INDEX, never the read.** What an agent can `fs_read` is set by the source ROOT and by
|
|
189
218
|
`permissions.paths[]` — so narrowing a wide source with `include` alone leaves every
|
|
190
219
|
file under that root readable. Re-root it, or add a path deny, or both.
|
|
@@ -221,25 +250,35 @@ theirs.
|
|
|
221
250
|
|
|
222
251
|
```bash
|
|
223
252
|
# Disposable source from the lifecycle walkthrough only; estimate first.
|
|
224
|
-
|
|
253
|
+
echo '{"source":"scratch-demo","mode":"estimate","obsoleteOnly":true,"selector":{"kind":"source"}}' | neuralis request POST @neuralis/brain-core/sources/purge --input -
|
|
225
254
|
# Apply only after reviewing the same selection’s counts.
|
|
226
|
-
|
|
255
|
+
echo '{"source":"scratch-demo","mode":"apply","obsoleteOnly":true,"selector":{"kind":"source"}}' | neuralis request POST @neuralis/brain-core/sources/purge --input -
|
|
227
256
|
# A canonical folder selection, still estimate-only:
|
|
228
|
-
|
|
257
|
+
echo '{"source":"scratch-demo","mode":"estimate","obsoleteOnly":false,"selector":{"kind":"folder","uri":"scratch-demo://docs"}}' | neuralis request POST @neuralis/brain-core/sources/purge --input -
|
|
229
258
|
```
|
|
230
259
|
|
|
231
260
|
## Re-embed (a file, a folder, a source)
|
|
232
261
|
|
|
233
|
-
"Rescan changes" reuses unchanged indexed files, but rebuilds re-included recovery-only content. `
|
|
262
|
+
"Rescan changes" reuses unchanged indexed files, but rebuilds re-included recovery-only content. `embeddingOnly:true` catches up missing/stale indexed embeddings, including brain-only and unchanged legacy records. Its read-only estimate returns `estimate_kind:scope_upper_bound`: authorized indexed scope counts are an upper bound, not a provider quote; no provider call or job starts. Show the estimate before you send the same body without `estimate` (202 + embedding job; poll `sources/sync-status`). Disabled embedding refuses: each `GET sources` row's `embedding_enabled` is the live platform switch, and while it is `false` the re-embed answers 409 `embedding_disabled`; without an active dense generation the estimate refuses and a submitted job pauses as `metadata_only`, never activating a model. `force:true` instead rereads and re-embeds the connector scope; its estimate includes `{documents,estimate:{tokens,relStdErr,usd,seconds}}` (`usd:null` for an unpriced model). A single file you may not read answers
|
|
234
263
|
`404`, exactly like a missing one. Switching the platform to a DIFFERENT model is not this:
|
|
235
264
|
that is the owner's rebuild in the admin Vector section.
|
|
236
265
|
|
|
237
|
-
|
|
266
|
+
```bash
|
|
267
|
+
# Read-only estimates first (no job, no provider call): debt catch-up, then a forced re-embed of one folder.
|
|
268
|
+
neuralis request POST @neuralis/brain-core/sources/reindex -f source=scratch-demo -F embeddingOnly=true -F estimate=true
|
|
269
|
+
neuralis request POST @neuralis/brain-core/sources/reindex -f source=scratch-demo -f folder=scratch-demo://docs -F force=true -F estimate=true
|
|
270
|
+
# Starts a paid embedding job (202) — the same body without `estimate`.
|
|
271
|
+
neuralis request POST @neuralis/brain-core/sources/reindex -f source=scratch-demo -F embeddingOnly=true
|
|
272
|
+
```
|
|
273
|
+
|
|
274
|
+
## Package sources (`packageFolders`)
|
|
238
275
|
|
|
239
|
-
Create and update accept `
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
276
|
+
Create and update accept `packageFolders` in the body: the folders of the source, relative
|
|
277
|
+
to its root, whose packages the host loads (`""` = the whole source, `"tools/pkgs"` = that
|
|
278
|
+
folder; no `..`, no absolute path; `[]` clears them). It does NOT switch markdown discovery
|
|
279
|
+
on — a synced source's markdown becomes source-package contributions (skill / instruction /
|
|
280
|
+
rule / agent / docs) either way; the folders let the host load packages from them as runtime
|
|
281
|
+
package sources (create-package
|
|
243
282
|
`references/connectors-and-uri-policies.md` §Declare source instances owns the details). Two
|
|
244
283
|
server-side gates apply regardless of what you send (`src/routes/sources.ts`):
|
|
245
284
|
|
|
@@ -249,14 +288,16 @@ server-side gates apply regardless of what you send (`src/routes/sources.ts`):
|
|
|
249
288
|
member 20 · viewer 30, lower = stronger), or who holds a `'*'` wildcard
|
|
250
289
|
feature grant. A CUSTOM role that declares `priority: 2` passes exactly like
|
|
251
290
|
the built-in `admin`; a role NAMED `admin` is not what is checked. Anything
|
|
252
|
-
weaker gets `403 Setting
|
|
291
|
+
weaker gets `403 Setting packageFolders requires an owner/admin-effective
|
|
253
292
|
role.` — quote that string verbatim when you report it. It names the required
|
|
254
293
|
STRENGTH, not a role you have to be called. This is the SECOND gate on the
|
|
255
294
|
route: `sources.mount` is checked first for the whole PATCH, so a caller without
|
|
256
295
|
it never reaches this message and sees `403 Updating sources requires
|
|
257
296
|
sources.mount.` instead. Read the two strings as different answers — a missing
|
|
258
297
|
feature grant versus insufficient role strength.
|
|
259
|
-
-
|
|
298
|
+
- **`host` kind only** — setting it on another kind returns `400`. On a folder on a paired
|
|
299
|
+
device the packages are read over its link, never copied here; their skill scripts run on
|
|
300
|
+
that device. While it is offline its packages read "Not available".
|
|
260
301
|
|
|
261
302
|
A package delivered through a **user/agent-scoped** source is advertised only to that
|
|
262
303
|
scope (a different run identity sees nothing — correct-by-design, not a load failure).
|
|
@@ -266,11 +307,11 @@ scope (a different run identity sees nothing — correct-by-design, not a load f
|
|
|
266
307
|
# and already holds markdown, so this edits a REAL source. `repo` is a stand-in:
|
|
267
308
|
# substitute a slug from the sources list. The effect is live — every matching .md under
|
|
268
309
|
# it starts being advertised as a package contribution on the next sync — and it
|
|
269
|
-
# is reversible only by resending the same body with `
|
|
310
|
+
# is reversible only by resending the same body with `packageFolders:[]`.
|
|
270
311
|
# Needs sources.mount, then priority <= 2 (the admin anchor) or a '*' grant, and a
|
|
271
|
-
#
|
|
312
|
+
# folder source. The body carries the source's CURRENT permissions back —
|
|
272
313
|
# PATCH replaces them:
|
|
273
|
-
neuralis request GET @neuralis/brain-core/sources --jq '.[] | select(.source=="repo") | {source, permissions,
|
|
314
|
+
neuralis request GET @neuralis/brain-core/sources --jq '.[] | select(.source=="repo") | {source, permissions, packageFolders:[""]}' | neuralis request PATCH @neuralis/brain-core/sources --input -
|
|
274
315
|
```
|
|
275
316
|
|
|
276
317
|
## `description` field
|
|
@@ -299,18 +340,17 @@ neuralis request GET @neuralis/brain-core/sources
|
|
|
299
340
|
# a TOP-LEVEL ARRAY → filter with .[] (NOT .sources[]):
|
|
300
341
|
# Each row IS the source config: the slug lives in `.source` (there is no `.slug` key).
|
|
301
342
|
neuralis request GET @neuralis/brain-core/sources --jq '.[] | {source, enabled, kind: .connection.kind, orphan}'
|
|
302
|
-
neuralis request GET @neuralis/brain-core/sources --jq '.[] | select(.connection.kind=="
|
|
343
|
+
neuralis request GET @neuralis/brain-core/sources --jq '.[] | select(.connection.kind=="host" and (.connection.config.device|not))'
|
|
303
344
|
# The kind is the registry KIND, not a connector id or a UI label. Enumerate them
|
|
304
|
-
# (today: brain, host,
|
|
345
|
+
# (today: brain, host, webtop); an unregistered value is 404
|
|
305
346
|
# `Unknown kind "<x>"` for EVERY caller, so it is never a permission problem.
|
|
306
|
-
# The on-disk connector's id is `local-disk` but its kind is `local` — send `local`.
|
|
307
347
|
neuralis request GET @neuralis/brain-core/sources/kinds --jq '.kinds[].kind'
|
|
308
|
-
neuralis request GET @neuralis/brain-core/sources/kinds/
|
|
348
|
+
neuralis request GET @neuralis/brain-core/sources/kinds/host/schema
|
|
309
349
|
neuralis request POST @neuralis/brain-core/sources/sync -f source=data # needs sources.sync
|
|
310
350
|
neuralis request GET @neuralis/brain-core/sources/sync-status -f source=data
|
|
311
351
|
# `"auto"` = live only while the source's runtime runs; a boolean is typed with -F
|
|
312
352
|
neuralis request POST @neuralis/brain-core/sources/enabled -f source=data -F enabled=true
|
|
313
|
-
neuralis request GET @neuralis/brain-core/sources/browse -f path
|
|
353
|
+
neuralis request GET @neuralis/brain-core/sources/browse -f path="$DATA_ROOT" # needs sources.mount; DATA_ROOT = the data source's container= path
|
|
314
354
|
```
|
|
315
355
|
|
|
316
356
|
### Lifecycle walkthrough — create → update → delete
|
|
@@ -328,7 +368,7 @@ the throwaway.
|
|
|
328
368
|
```bash
|
|
329
369
|
# 1. Create (needs sources.mount). source + connection.kind + permissions.default.* required.
|
|
330
370
|
# The root does not have to exist yet — create records the coordinate, sync walks it.
|
|
331
|
-
|
|
371
|
+
echo '{"source":"scratch-demo","connection":{"kind":"host","config":{"root":"/tmp/scratch-demo"}},"permissions":{"default":{"read":true,"write":true,"exec":false}}}' | neuralis request POST @neuralis/brain-core/sources --input -
|
|
332
372
|
# 2. Update — NO SLUG; the body `source` field is the key (needs sources.mount).
|
|
333
373
|
# Sets the description shown in the agent <runtime_stack>. `permissions` is
|
|
334
374
|
# REPLACED, so read the live object back and resend it unchanged, editing only
|
|
@@ -391,5 +431,5 @@ neuralis request GET @neuralis/brain-core/health/scan
|
|
|
391
431
|
duplicate groups (from `/health/scan`); unindexed/stale per source (from `fs_list`).
|
|
392
432
|
3. A changed embedding model is never mixed in: the index keeps embedding with the model
|
|
393
433
|
it was built with until the owner rebuilds it from the admin Vector section — no reset.
|
|
394
|
-
4. If issues found, suggest specific remediation: source sync for stale data, `
|
|
434
|
+
4. If issues found, suggest specific remediation: source sync for stale data, a `force` re-embed for
|
|
395
435
|
files whose vectors look wrong, `POST /health/gc` to gc / repair-orphans / deduplicate.
|
|
@@ -66,22 +66,25 @@ undone.
|
|
|
66
66
|
# 0. Read the policy you are about to change, so you can prove you restored it.
|
|
67
67
|
neuralis request GET @neuralis/brain-core/policies/uri/data
|
|
68
68
|
# 1. Add the rule (LIVE — members lose read on this subtree immediately).
|
|
69
|
-
|
|
69
|
+
echo '{"source":"data","addPaths":[{"pattern":"data://agent-core/admin/**","permissions":{"read":false},"roles":["member"]}]}' | neuralis request POST @neuralis/brain-core/policies/uri --input -
|
|
70
70
|
# 2. Take it back — same source, same pattern, byte for byte.
|
|
71
|
-
|
|
71
|
+
echo '{"source":"data","removePatterns":["data://agent-core/admin/**"]}' | neuralis request POST @neuralis/brain-core/policies/uri --input -
|
|
72
72
|
```
|
|
73
73
|
|
|
74
74
|
To keep a rule, run step 1 and stop; step 2 exists so the example is reversible
|
|
75
75
|
rather than a permanent edit to a live source's access policy.
|
|
76
76
|
|
|
77
77
|
Body: `source` (slug, required) plus either `addPaths` — rules of `{pattern,
|
|
78
|
-
permissions, roles?}`, where `pattern` takes `**` wildcards, `permissions` maps
|
|
79
|
-
`read`/`write`/`exec` to `false` (deny) or `true` (allow)
|
|
80
|
-
rule
|
|
78
|
+
permissions, roles?, priority?, override?}`, where `pattern` takes `**` wildcards, `permissions` maps
|
|
79
|
+
`read`/`write`/`exec` to `false` (deny) or `true` (allow), `roles` scopes the
|
|
80
|
+
rule to named project roles (each must exist in the project, else 400) and
|
|
81
|
+
`priority: 2` to callers whose role priority is 2 or stronger — admin and owner,
|
|
82
|
+
lower = stronger (an integer 1..99, only on a grant row: `override: true` with every
|
|
83
|
+
listed bit `true`); present fields all apply — or `removePatterns` (the patterns to take back).
|
|
81
84
|
|
|
82
85
|
`exec` decides whether a shell may START in that directory — on an exec-capable
|
|
83
86
|
source (a virtual desktop or any other one whose connector runs commands) as
|
|
84
|
-
well as
|
|
87
|
+
well as on the app's own machine. A caller also needs that plane's entry feature; the
|
|
85
88
|
policy row alone does not grant one, and the entry alone does not grant the row.
|
|
86
89
|
So a source whose owner reports "I hold the feature and the shell is still
|
|
87
90
|
refused" usually needs an `exec` ALLOW row for their role or agent here.
|
package/skills/sync/SKILL.md
CHANGED
|
@@ -14,7 +14,7 @@ Trigger a delta sync for the brain-core filesystem.
|
|
|
14
14
|
1. Use `fs_list` with no `uri` first to identify configured sources, scopes, current sync status, and recent errors.
|
|
15
15
|
2. Call the brain-core source sync route for the intended source. The route answers 202 + a queue job snapshot — the sync runs in the background. Explicit sync requires `sources.sync`; source create/update/delete uses `sources.mount`; file writes use `files.write`.
|
|
16
16
|
3. Poll `GET /sources/sync-status?source=<slug>` until the job finishes, then report the job `result` counts: `filesAdded`, `filesUpdated`, `filesRemoved`, `filesSkipped`, `filesMoved`, `chunksRemoved`, `chunksEmbedded` and `chunksSkipped` plus `embeddingDegraded` (safe, deduplicated embedding stop reasons). Payload indexing can succeed with missing/stale embeddings; report that debt separately. Read the two flags before interpreting completion. `cancelled: true` is not a failure, but the run stopped early: the counts are partial and a re-run converges. `truncated: true` means the walk stopped at `filesScanCap`, so files past the cap were never examined and no deletion or move was inferred — call that a partial pass, never a completed sync.
|
|
17
|
-
4. If any errors occur, list them clearly with the affected source, scope, and file path.
|
|
17
|
+
4. If any errors occur, list them clearly with the affected source, scope, and file path. Two job errors are fixed codes and removed nothing: `root_unreachable` (the source root cannot be reached — unmounted, renamed, device offline; fix the mount, then sync again) and `root_empty` (the root answers but holds no file while the index still holds some). Re-send `confirmEmpty:true` with the sync only after the user confirms the folder really is empty — that one pass removes its files from the index.
|
|
18
18
|
5. Distinguish live connector data, indexed payload and embedding freshness. Provider outage or disabled embedding preserves metadata/full-text indexing; semantic results may be old, or the response may fall back to filter search. Ordinary sync completion does not settle all embedding debt. Use `manage-sources` explicit debt catchup; terminal `paused` carries `result.embedding.pausedReason`, and Resume creates a new authorized job from durable debt.
|
|
19
19
|
|
|
20
20
|
## What a sync will and will not index
|