SharePoint

SharePointVFS shares its file-operation backend with OneDrive. Its additional resolver maps SharePoint sites and document libraries onto the virtual tree.

import { MountMode, SharePointVFS, Workspace } from '@struktoai/mirage-node'

const sharepoint = new SharePointVFS({
  accessToken: () => getMicrosoftGraphToken(),
  tenantHost: 'contoso.sharepoint.com',
})

const ws = new Workspace({ '/sharepoint': sharepoint }, { mode: MountMode.WRITE })
await ws.shell('ls /sharepoint/')
await ws.shell('ls /sharepoint/Engineering/Documents/')

An unscoped mount uses /site/library/path. To hide the site and library levels, configure site and drive together; keyPrefix can narrow that drive further.

new SharePointVFS({
  accessToken,
  site: 'Engineering',
  drive: 'Documents',
  keyPrefix: 'Reports/2026',
})

Field	Description
`accessToken` required, secret	Microsoft Graph bearer token, or a function (sync or async) that returns one; it is called for each request and again after a `401`.
`tenantHost`	SharePoint host, such as `contoso.sharepoint.com`; the `sharepoint` mount lists only the sites whose `webUrl` is on it. The `onedrive` mount ignores it.
`graphBaseUrl`	Full Graph service root, version segment included, for any deployment but the worldwide one: a sovereign cloud, a private endpoint or a test server. Unset uses `https://graph.microsoft.com/v1.0`.
`timeout` default `DEFAULT_TIMEOUT`	Seconds a Graph request may wait to connect, or between two reads of its answer, before it fails; also how long a server-side copy is polled before it fails as unconfirmed.
`maxRetries` default `5`	Times a request is retried after a `429`, `503` or `504` response. Each retry waits what `Retry-After` asks or an exponential backoff, at most 30 seconds.
`siteFilter` default `'*'`	Search term passed to Graph’s `/sites?search=` to choose which sites the mount lists.
`site`	Site, by display name or internal name, that scopes the mount to one document library together with `drive`. With either unset the mount lists every site as `/<site>/<library>/...`.
`drive`	Document library in `site` that the mount uses as its root; takes effect only with `site` set.
`keyPrefix`	Folder path inside the scoped library that the mount uses as its root; takes effect only with `site` and `drive` set. `..` segments are rejected.

Fields marked secret are redacted in snapshots.

VFS.md

The VFS.md an agent reads with SharePoint mounted at /<path>.

Rendered
Raw

Virtual Filesystem

Path	Description
`/<path>`	`sharepoint`, write

`/<path>` layout

/<path>
  SharePoint Enterprise document libraries. Multi-site, multi-drive discovery.
  Unscoped mounts use: /{site_name}/{library_name}/{path_to_file}
  Unscoped level 0 (ls /): lists all accessible SharePoint sites.
  Unscoped level 1 (ls /site/): lists document libraries (drives) in that site.
  Unscoped level 2+ (ls /site/lib/...): lists files and folders in the drive.
  IMPORTANT: This is a remote mount. Prefer targeted reads (grep, head) over full scans. Avoid cat on large files without piping to head/tail.
  File versions are retained, snapshots pin and read prior versions.

Supported Unix Commands for VFS

Unix commands work on each path as on a local filesystem, as far as the path supports them:

Path	Supported
`/<path>`	Almost all Unix commands. `grep -r` and `rg` with `-w` ask `sharepoint` which files may match.

Limitations of Unix Commands for VFS

Where a path differs from a local filesystem:

Path	Limitations
`/<path>`	Without `-w`, `grep -r` and `rg` read every file. `grep -r`, `find` and `du` stop after 1000 files; a glob matching more, `tar -c`, `cp -r` and `rm -r` are refused.

Run man to list every command, and man <cmd> or <cmd> --help for one command’s usage.

---
name: workspace-filesystem
description: The virtual filesystem layout of this workspace.
---

# Virtual Filesystem

| Path | Description |
| --- | --- |
| `/<path>` | `sharepoint`, write |

## `/<path>` layout

```text
/<path>
  SharePoint Enterprise document libraries. Multi-site, multi-drive discovery.
  Unscoped mounts use: /{site_name}/{library_name}/{path_to_file}
  Unscoped level 0 (ls /): lists all accessible SharePoint sites.
  Unscoped level 1 (ls /site/): lists document libraries (drives) in that site.
  Unscoped level 2+ (ls /site/lib/...): lists files and folders in the drive.
  IMPORTANT: This is a remote mount. Prefer targeted reads (grep, head) over full scans. Avoid cat on large files without piping to head/tail.
  File versions are retained, snapshots pin and read prior versions.
```

## Supported Unix Commands for VFS

Unix commands work on each path as on a local filesystem, as far as the path supports them:

| Path | Supported |
| --- | --- |
| `/<path>` | Almost all Unix commands. `grep -r` and `rg` with `-w` ask `sharepoint` which files may match. |

## Limitations of Unix Commands for VFS

Where a path differs from a local filesystem:

| Path | Limitations |
| --- | --- |
| `/<path>` | Without `-w`, `grep -r` and `rg` read every file. `grep -r`, `find` and `du` stop after 1000 files; a glob matching more, `tar -c`, `cp -r` and `rm -r` are refused. |

Run `man` to list every command, and `man <cmd>` or `<cmd> --help` for one command's usage.

Integration

What SharePoint answers through its own API, so fewer files are read. Integration explains each command.

Command	On SharePoint
`grep -r`, `rg`	Microsoft Graph search within one document library, for whole words. It can miss Office files, PDFs, archives, the end of large files, words Graph splits differently (`foo.bar`) and recent writes.
`find`, `du`, `ls -R`, `tree`	One recursive listing

The Python SharePoint docs list when each search answers and what it can miss.

Getting Started

Access

AI Agents

VFS

CLIs

Runtimes

VFS.md

Virtual Filesystem

`/<path>` layout

Supported Unix Commands for VFS

Limitations of Unix Commands for VFS

Integration

​VFS.md

​Virtual Filesystem

​/<path> layout

​Supported Unix Commands for VFS

​Limitations of Unix Commands for VFS

​Integration

VFS.md

Virtual Filesystem

`/<path>` layout

Supported Unix Commands for VFS

Limitations of Unix Commands for VFS

Integration