.xlsx workbooks and Word .docx documents natively — cell values and document text are parsed in-process, with no download, OCR or external extraction service. It can be consumed two ways: as a remote MCP server that Agent Factory agents call as tools, or as a Builder app whose instructions you call directly from DSUL. The MCP surface groups every operation into nine entity tools (sites, drives, items, search, permissions, lists, directory, workbook, documents), each driven by an action argument, and runs in the tenant app-instance context (it resolves the installing workspace’s own credentials). Authentication is per-user and supports several modes:
- Per-user OAuth2 — central client (
oauthCentral, recommended) — one Microsoft Entra OAuth Application is registered once by the platform maintainer; every end user signs in with their own Microsoft account. Nothing to register per tenant: each workspace just installs the app and clicks Connect. - Per-user OAuth2 — tenant client (
oauth) — paste your own Entra application (client) ID/secret in the connector config app. Each user signs in with their own account against your client (PKCE authorization-code flow). - Application — client credentials (
clientCredentials) — an Entra app with application Graph permissions and admin consent, acting without an interactive sign-in. Best for back-office / service automations and content indexing. - Direct access token (
accessToken) — a caller-managed Microsoft Graph access token, used as-is with no exchange.
Sites & files
Discover sites and subsites, browse document libraries and folders, read/create/move/copy files, get pre-signed download URLs, thumbnails and versions — and read Excel
.xlsx workbooks and Word .docx documents natively (cell values, full text)Lists, search & permissions
Query and write SharePoint lists and list items, run Microsoft Search across drives and sites, and inspect or manage sharing permissions for access-aware RAG
Flexible per-user auth
Per-user Microsoft Entra OAuth (central or tenant client), application client-credentials, or a direct access token
Who is this for?
This connector is used by three different roles. Jump to the section that matches yours — each one is self-contained.Agent builder
You build agents in Agent Factory and want them to browse SharePoint sites, read files and query lists. → Agent builder tab.
Platform admin
You run the platform and set up the shared Microsoft Entra OAuth client once for everyone. → Platform admin setup accordion below.
Workspace builder
You write Builder automations (DSUL) that call SharePoint operations directly. → Workspace builder tab.
Prerequisites (Microsoft side)
- A Microsoft 365 / SharePoint Online tenant, and an Azure / Microsoft Entra ID tenant where you can register an application (or a maintainer who already did).
- An app registration in Microsoft Entra ID (Azure portal → App registrations), with a client secret created under Certificates & secrets.
- Microsoft Graph delegated permissions granted on the app (for the per-user OAuth modes), covering the resources you intend to use:
- Sites & files:
Sites.Read.All(orSites.ReadWrite.Allfor create/update/move),Files.Read.All(orFiles.ReadWrite.All) - Directory (access-aware RAG):
User.Read,GroupMember.Read.All(optional) - Sign-in / identity:
openid,profile,offline_access
- Sites & files:
- For the application (client-credentials) mode instead, grant the equivalent application permissions (e.g.
Sites.Read.All,Files.Read.All) and have a Global Administrator grant admin consent.
Platform admin (Governance) — one-time platform setup
Platform admin (Governance) — one-time platform setup
Goal: two one-time tasks — (1) configure the shared central Microsoft Entra OAuth client so every workspace lets its users sign in with their own Microsoft account, and (2) expose SharePoint as a reusable capability in AI Governance so agent builders can pick it without pasting endpoint URLs.
1. Configure the connector
Register the OAuth Application in Microsoft Entra ID
In Microsoft Entra ID → App registrations > New registration, register a Web application. Add a Redirect URI pointing at the core workspace callback:(e.g.
https://api.studio.prisme.ai/v2/workspaces/7oQvI6Q/webhooks/oauthCallback on production).Add the Microsoft Graph delegated permissions listed in Prerequisites, create a client secret under Certificates & secrets, and note the Application (client) ID, the secret value, and the Directory (tenant) ID (or use common / organizations for multi-tenant).Enter the credentials through the configuration app
Open the central
sharepoint-next workspace and launch its Configuration app — <studio>/apps/sharepoint-next (e.g. https://studio.prisme.ai/apps/sharepoint-next), also linked as Configuration app on the installed instance. Switch to the maintainer view and follow the in-app instructions to paste the Client ID, Client Secret, Tenant and (optionally) scopes — the app stores them in the core workspace’s secrets for you. Do not edit Studio’s raw Secrets by hand. These credentials stay in the sharepoint-next workspace and are never exposed to tenants or end users; token exchange is proxied through the core centralTokenExchange webhook so the client secret never leaves the core workspace.2. Declare the capability in AI Governance
Generic connectors — broad tool surfaces meant to be shared across many agents, like SharePoint — are best exposed as a named capability in AI Governance. Agent builders then enable that capability on their agents instead of pasting a raw MCP endpoint.Point it at the MCP endpoint
Set the capability’s MCP server URL to the connector’s MCP Endpoint, and set its Scope to:The
agent_id in the scope is what lets the connector identify and authorize the calling agent.Make it available to agent builders
Once created, the capability appears in the capability picker for agent builders in your organization, who enable it on their agents. Access to the catalog follows your organization’s existing roles; there is no per-capability role grant.
The connector’s configuration app also offers a one-click Add to catalog button (workspace owner / admin only) that publishes the SharePoint capability to the organization-wide Capabilities catalog for you — the easiest way to expose it to agent builders without hand-editing Governance.
- Agent builder (Agent Factory)
- Workspace builder (DSUL)
Agent builder
Goal: let an agent you build in Agent Factory browse SharePoint sites, read and manage files, query lists, and check permissions through MCP tools.Before an agent can call the connector, a Workspace builder must have installed and configured the SharePoint app in a workspace (see the Workspace builder tab), and — for the central OAuth mode — a Platform admin must have provisioned the shared Microsoft Entra OAuth client (see the Platform admin setup accordion above).
agent_id that Agent Factory injects through the capability Scope, and that agent must appear in the connector’s authorized-agents allowlist (managed in the configuration app). The Microsoft Graph access token itself is resolved server-side from the configured auth mode.There are two ways to wire it up. Pick based on how much isolation you need.Option A — Enable the shared capability from the catalog
The fastest path: a Platform admin has already published a SharePoint capability (see the Platform admin setup accordion above, §2), so you just pick it from the catalog. A workspace owner can publish it in one click with the config app’s Add to catalog button.Open your agent in Agent Factory
Open the agent you want to extend and go to its capabilities / tools.
Add the SharePoint capability
Browse the capability catalog, select SharePoint, and enable it. The MCP endpoint URL and the Scope (
context_id,agent_id,user_id) are already wired by the admin — nothing to paste, and the shared instance accepts every agent, so there is no allowlist step on your side.Convenient, but your agent runs against a shared, platform-managed instance: its Microsoft credentials are owned by someone else and the instance accepts every agent that is granted the capability. Prefer Option B for anything beyond quick experiments.
Option B — Run it from your own workspace (recommended)
For production agents, install the connector in your own workspace and point the agent at that workspace’s MCP endpoint.Install and configure the connector in your workspace
Follow the Workspace builder tab: install SharePoint in your workspace, open its Configuration app, choose the auth mode and connect a Microsoft account.
Allowlist your agent
In that workspace’s config app, open Authorized agents and tick your agent (the Install capability button does this for you).
Add the MCP capability to your agent
In your agent, add a capability pointing at your workspace’s MCP Endpoint URL, and set its Scope to:The
agent_id is what lets the connector identify and authorize your agent — without it, every call is rejected with an explicit “agent could not be identified” message. This Scope is separate from the Microsoft Graph OAuth scopes.Brief the agent in its system prompt
Whichever option you pick, wiring the capability is not enough — the agent must know the MCP exists and when to use it. Copy-pasteable starter:Legacy AI Knowledge agents (no native MCP picker): add the connector under Advanced > Tools > MCP and paste the MCP Endpoint URL. The agent still has to be allowlisted in the config app and its identity propagated so the connector can read its
agent_id.Restricting to read-only (least privilege). SharePoint tools cover both reads and writes (upload, create, move). The connector already requests read-only Graph scopes by default (Any write attempt is then rejected by Microsoft Graph with
Sites.Read.All, Files.Read.All); writes are only possible if you widen the Scopes field in the configuration app to Sites.ReadWrite.All / Files.ReadWrite.All. To keep the connector read-only, simply leave the default read scopes:403 Forbidden. The scope is set at the workspace level (a workspace editor can widen it); for a hard guarantee, use an Entra app limited to read permissions.Available Tools
Each tool takes anaction argument selecting the concrete operation, plus the per-action parameters.| Tool | Description |
|---|---|
sites | SharePoint sites discovery. Actions: search, get, getRoot, listSubsites. |
drives | Document libraries (drives) of sites and OneDrive. Actions: listForSite, getSiteDefault, get, getMine, listMine. |
items | Files & folders (driveItems). get / listChildren return a @microsoft.graph.downloadUrl (~1h pre-signed) — content is not inline. Actions: listChildren, listRootChildren, get, createFolder, update, delete, copy, thumbnails, versions. |
search | Microsoft Search across SharePoint / OneDrive. Action: query. |
permissions | Sharing & permissions on driveItems (access-aware RAG). Actions: list, get, invite, createLink, delete. |
lists | SharePoint lists and list items. Actions: listForSite, get, listItems, getItem, createItem, updateItemFields, deleteItem. |
directory | Azure AD users & groups — resolve identities and group membership. Actions: getUser, userMemberOf, checkUserMemberGroups, getGroup, groupMembers. |
workbook | Read & write Excel .xlsx workbooks natively via the Microsoft Graph Excel API — no download, no OCR; cells are returned as structured values. Target a file by driveId + itemId. Actions: listWorksheets, usedRange, getRange, listTables, listTableRows, updateRange, addTableRow, addWorksheet, createTable, executeFunction. |
documents | Read the content of Word .docx documents natively — no external extraction service, no OCR; parses the OOXML in-process. Target a file by driveId + itemId. Actions: getText, getStructure. |
Output Formats
Every tool accepts anoutputFormat argument that controls the MCP response shape:verbose(default) — a human-readable text view, optimized for LLM consumption.structured— concise machine-readable JSON instructuredContent.both— the structured payload, with its JSON also rendered as text.
Tool Details
sites
| Parameter | Required | Description |
|---|---|---|
action | Yes | One of search, get, getRoot, listSubsites. |
siteId | For get/listSubsites | SharePoint site id (hostname,siteCollectionId,siteId). |
search | For search | Keyword to match sites; use * to list all. |
top / select | No | OData $top / $select. |
drives
| Parameter | Required | Description |
|---|---|---|
action | Yes | One of listForSite, getSiteDefault, get, getMine, listMine. |
siteId | For listForSite/getSiteDefault | SharePoint site id. |
driveId | For get | Drive (document library) id. |
select | No | OData $select. |
items
| Parameter | Required | Description |
|---|---|---|
action | Yes | One of listChildren, listRootChildren, get, createFolder, update, delete, copy, thumbnails, versions. |
driveId | Yes | Drive id (required for all item actions). |
itemId | For get/update/delete/copy/thumbnails/versions/listChildren | DriveItem id. |
parentItemId | For createFolder | Parent folder item id. |
top / select / orderby / expand / skiptoken | No | OData query options and pagination. |
body | For createFolder/update/copy | JSON body, e.g. createFolder → { name, folder: {}, "@microsoft.graph.conflictBehavior" }; copy → { parentReference, name }. |
items — reading a file’s content
get and listChildren return each file’s @microsoft.graph.downloadUrl, a ~1-hour pre-signed link. Fetch that URL out-of-band to read the bytes; the MCP response never embeds file content inline.lists
| Parameter | Required | Description |
|---|---|---|
action | Yes | One of listForSite, get, listItems, getItem, createItem, updateItemFields, deleteItem. |
siteId | Yes | SharePoint site id. |
listId | For get/listItems/getItem/createItem/updateItemFields/deleteItem | SharePoint list id. |
itemId | For getItem/updateItemFields/deleteItem | List item id. |
expand | No | OData $expand; use fields to get column values. |
select / top / filter | No | OData query options. |
body | For createItem/updateItemFields | createItem → { fields: { <Column>: <value> } }; updateItemFields → { <Column>: <value> }. |
permissions
| Parameter | Required | Description |
|---|---|---|
action | Yes | One of list, get, invite, createLink, delete. |
driveId | Yes | Drive id. |
itemId | Yes | DriveItem id. |
permId | For get/delete | Permission id. |
body | For invite/createLink | invite → { recipients, roles, requireSignIn, sendInvitation }; createLink → { type, scope }. |
workbook
Read & write the cells of an Excel.xlsx file natively via the Microsoft Graph Excel API — no download, no OCR.| Parameter | Required | Description |
|---|---|---|
action | Yes | One of listWorksheets, usedRange, getRange, listTables, listTableRows, updateRange, addTableRow, addWorksheet, createTable, executeFunction. |
driveId | Yes | Drive id containing the .xlsx file. |
itemId | Yes | DriveItem id of the .xlsx file. |
worksheetId | For usedRange/getRange/updateRange | Worksheet id or name. |
address | For getRange/updateRange | A1 range address, e.g. "A1:D50" or "Sheet1!A1:D50". |
tableId | For listTableRows/addTableRow | Table id or name. |
functionName | For executeFunction | Excel function name, e.g. "vlookup", "sum", "today". |
top / select | No | Query options (listTableRows top, OData $select). |
body | For write actions | { values: [[...], [...]] } (updateRange / addTableRow), { name } (addWorksheet), { address, hasHeaders } (createTable), or the function’s named arguments (executeFunction, e.g. { values: [[...]] }). |
addWorksheet, createTable and executeFunction evaluate / mutate the workbook server-side. executeFunction returns { value } — the evaluated result of the Excel function.documents
Read the content of a Word.docx file natively — the file is downloaded and its OOXML parsed in-process (no external extraction service, no OCR).| Parameter | Required | Description |
|---|---|---|
action | Yes | getText — full plain text (paragraphs + table cells), capped ~200 KB, best for RAG / reading; or getStructure — the element tree (paragraphs with style/runs/formatting, tables with rows/cols/headers/cells) plus metadata and the full text. |
driveId | Yes | Drive id containing the .docx file. |
itemId | Yes | DriveItem id of the .docx file. |
includeContent | No (getStructure only) | Include per-element text/runs (default true). Ignored by getText. |
maxContentLength | No (getStructure only) | Max characters of text per element (0 = no per-element cap). |
Error Handling
| HTTP code | Meaning |
|---|---|
400 | Bad request — invalid parameters or malformed body (e.g. bad OData filter, invalid driveItem/list resource). |
401 | Unauthorized — the Microsoft Graph access token is missing, expired or revoked. The user must reconnect (OAuth modes). |
403 | Forbidden — insufficient Graph scope/permission, missing admin consent (application mode), or the account lacks access to the site/drive/item. |
404 | Not found — the site, drive, item, list or permission id does not exist or is not visible to the account. |
429 | Throttled — Microsoft Graph rate limit; back off and retry (honor Retry-After). |
500 / 503 | Microsoft Graph service error — transient; retry shortly, no reconnection needed. |
Common Issues
“This agent is not authorized to use this connector” — The calling agent is not in the allowlist. Open the configuration app → Authorized agents → tick this agent (or enable Allow all agents) and Save. “The calling agent could not be identified” — The MCP capability Scope does not declareagent_id, so Agent Factory never injects the agent identity. Set the Scope to context_id,agent_id,user_id on the capability, then allow the agent in the config app.
“Microsoft Graph is not connected for this user” — No per-user OAuth token. Open the configuration app (OAuth mode) and click Connect, or use the agent’s connect flow.
“Microsoft Graph token refresh failed … must reconnect” — The stored refresh token was revoked or expired (Microsoft Entra invalidated it, or it aged past its limit). The connection is dropped automatically; the user must reconnect from the config app.
“Microsoft Graph not authenticated” / “OAuth is not configured” — Neither a tenant OAuth client nor the central platform client is available. Set the client ID/secret/tenant in the config app, or ask the platform maintainer to provision the central Entra OAuth client.
client_credentials exchange failed — In application mode, check the Application (client) ID / secret, the tenant id, and that a Global Administrator granted admin consent for the application Graph permissions.
“Site not found” — The site id format is hostname,siteCollectionId,siteId. Use sites search (or Graph Explorer) to find the correct id.
Microsoft Entra redirect URI rejected — Entra rejects a colon in the redirect URI path. Register the redirect URI with the workspace’s raw id (/workspaces/<workspace-id>/webhooks/oauthCallback), not the slug: form — copy the exact value from the config app.
External Resources
Microsoft Graph API
Official reference for the SharePoint sites, drives, files, lists and permissions REST APIs.
Tool Agents
Learn how Agent Factory agents consume MCP tools in Prisme.ai.