> ## Documentation Index
> Fetch the complete documentation index at: https://prismeai-docs-next.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# SharePoint

> Browse and download files from SharePoint document libraries

The SharePoint connector provides access to Microsoft SharePoint Online document libraries via the Microsoft Graph API, enabling AI agents and automations to browse folders, list files, and download content.

<CardGroup cols={3}>
  <Card title="Browse Structure" icon="folder-tree">
    List sites, drives, and folder hierarchies
  </Card>

  <Card title="File Access" icon="file">
    Download files with metadata for change detection
  </Card>

  <Card title="Access Control" icon="shield">
    Per-user permission validation (PBAV) for secure access
  </Card>
</CardGroup>

## Prerequisites

* An **Azure AD Application** registered in your tenant
* **Application permissions** granted:
  * `Sites.Read.All` - Read sites and files
  * `Files.Read.All` - Read file content
  * `GroupMember.Read.All` - For PBAV group membership checks (optional)
* **Admin consent** granted for these permissions

<Note>
  For Knowledges document sync with per-user access control, see the dedicated [SharePoint Connector for Knowledges](/products/ai-knowledge/connectors) documentation.
</Note>

***

<Tabs>
  <Tab title="Usage as App">
    ## Installation

    1. Go to **Apps** in your workspace
    2. Search for **Sharepoint** and install it
    3. Configure the app instance with your Azure AD credentials

    ## Configuration

    | Field             | Value                                 |
    | ----------------- | ------------------------------------- |
    | **Client ID**     | Application (client) ID from Azure AD |
    | **Client Secret** | Client secret value                   |
    | **Tenant ID**     | Directory (tenant) ID                 |
    | **Site URL**      | Optional, default SharePoint site URL |
    | **Site ID**       | Optional, default SharePoint site ID  |

    ## Available Automations

    ### Site Operations

    | Automation  | Description                                 |
    | ----------- | ------------------------------------------- |
    | `listSites` | List SharePoint sites accessible to the app |

    ### Drive Operations

    | Automation   | Description                       |
    | ------------ | --------------------------------- |
    | `listDrives` | List document libraries in a site |

    ### File & Folder Operations

    | Automation     | Description                          |
    | -------------- | ------------------------------------ |
    | `listChildren` | List items in a folder or drive root |
    | `getItem`      | Get item metadata by ID              |
    | `getFiles`     | List files with metadata             |
    | `getFileTree`  | Get recursive folder structure       |
    | `downloadFile` | Download file content                |

    ### Authentication

    | Automation          | Description                 |
    | ------------------- | --------------------------- |
    | `ensureAccessToken` | Get or refresh access token |
    | `getAccessToken`    | Get a new access token      |

    ## DSUL Examples

    ### List Sites

    ```yaml theme={null}
    - Sharepoint.listSites:
        output: sites
    ```

    ### List Document Libraries

    ```yaml theme={null}
    - Sharepoint.listDrives:
        siteId: "contoso.sharepoint.com,abc-123,def-456"
        output: drives
    ```

    ### List Files in a Folder

    ```yaml theme={null}
    - Sharepoint.listChildren:
        siteId: "contoso.sharepoint.com,abc-123,def-456"
        driveId: "b!xyz..."
        itemId: "01ABCDEF..."
        output: items
    ```

    ### Download a File

    ```yaml theme={null}
    - Sharepoint.downloadFile:
        siteId: "contoso.sharepoint.com,abc-123,def-456"
        driveId: "b!xyz..."
        itemId: "01ABCDEF..."
        output: fileContent
    ```

    ### Get Folder Tree

    ```yaml theme={null}
    - Sharepoint.getFileTree:
        siteId: "contoso.sharepoint.com,abc-123,def-456"
        driveId: "b!xyz..."
        output: tree
    ```
  </Tab>

  <Tab title="Usage as MCP">
    ## MCP Setup

    1. Open your **Knowledges project**
    2. Go to **Advanced > Tools**
    3. Click **Add** and select the **MCP** tab
    4. Enter the MCP endpoint URL
    5. In the **Headers** field, add your credentials:

    ```json theme={null}
    {
      "mcp-api-key": "your-mcp-api-key",
      "azure-client-id": "your-client-id",
      "azure-client-secret": "your-client-secret",
      "azure-tenant": "your-tenant-id"
    }
    ```

    ## Authentication

    The MCP server supports both service-to-service and delegated authentication:

    ### Service Account (Client Credentials)

    Configure workspace secrets:

    | Secret              | Description                         |
    | ------------------- | ----------------------------------- |
    | `azureClientId`     | Azure AD client ID                  |
    | `azureClientSecret` | Azure AD client secret              |
    | `azureTenant`       | Azure AD tenant ID                  |
    | `azureSiteId`       | Optional default SharePoint site ID |

    ### Delegated Auth (OAuth)

    For per-user access with PBAV (Permission-Based Access Validation), users connect their Microsoft account via OAuth. This enables:

    * Per-user file access validation
    * Respecting SharePoint permissions at query time
    * Secure document access in multi-tenant environments

    ## Available Tools

    | Tool                     | Description                                       |
    | ------------------------ | ------------------------------------------------- |
    | `configureSharePoint`    | Configure credentials for service-to-service auth |
    | `listSharePointFolders`  | List folders and document libraries               |
    | `listSharePointFiles`    | List files with metadata for RAG indexing         |
    | `downloadSharePointFile` | Download file content                             |

    ## Tool Details

    ### configureSharePoint

    Configure SharePoint credentials for Client Credentials Flow.

    ```json theme={null}
    {
      "name": "configureSharePoint",
      "arguments": {
        "clientId": "your-azure-client-id",
        "clientSecret": "your-client-secret",
        "tenant": "your-tenant-id"
      }
    }
    ```

    ### listSharePointFolders

    List folders and document libraries with metadata for change detection. Supports pagination.

    ```json theme={null}
    {
      "name": "listSharePointFolders",
      "arguments": {
        "siteId": "contoso.sharepoint.com,abc-123,def-456",
        "driveId": "b!xyz...",
        "folderId": "01ABCDEF..."
      }
    }
    ```

    | Parameter   | Description                                         |
    | ----------- | --------------------------------------------------- |
    | `siteId`    | SharePoint site ID (optional if default configured) |
    | `driveId`   | Document library ID (omit to list all drives)       |
    | `folderId`  | Folder item ID (omit for root)                      |
    | `pageToken` | Pagination token from previous response             |

    ### listSharePointFiles

    List files with full metadata for RAG indexing. Returns `eTag`, `cTag`, `contentHash` for change detection.

    ```json theme={null}
    {
      "name": "listSharePointFiles",
      "arguments": {
        "siteId": "contoso.sharepoint.com,abc-123,def-456",
        "driveId": "b!xyz...",
        "includeDownloadUrl": true
      }
    }
    ```

    | Parameter            | Description                                           |
    | -------------------- | ----------------------------------------------------- |
    | `siteId`             | SharePoint site ID (optional if default configured)   |
    | `driveId`            | Document library ID (required unless using pageToken) |
    | `folderId`           | Folder item ID (omit for drive root)                  |
    | `includeDownloadUrl` | Include pre-signed download URLs (default: false)     |
    | `pageToken`          | Pagination token from previous response               |

    ### downloadSharePointFile

    Download file content as text or base64-encoded binary.

    ```json theme={null}
    {
      "name": "downloadSharePointFile",
      "arguments": {
        "siteId": "contoso.sharepoint.com,abc-123,def-456",
        "driveId": "b!xyz...",
        "fileId": "01ABCDEF..."
      }
    }
    ```

    ## Output Formats

    All tools support an `outputFormat` parameter:

    * **`verbose`** (default) - Human-readable text for LLM consumption
    * **`structured`** - Machine-readable JSON in `structuredContent`
    * **`both`** - Both text and structured content

    ## Permission-Based Access Validation (PBAV)

    When using delegated OAuth, PBAV ensures that RAG query results respect each user's SharePoint permissions:

    1. User submits a query to the Knowledges agent
    2. RAG retrieves relevant document chunks
    3. For each SharePoint chunk, the system validates user access via their OAuth token
    4. Chunks from inaccessible files are filtered out before the LLM responds

    See [SharePoint Connector for Knowledges](/products/ai-knowledge/connectors) for detailed PBAV documentation.
  </Tab>
</Tabs>

***

## Error Handling

| HTTP Status | Error        | Solution                             |
| ----------- | ------------ | ------------------------------------ |
| 401         | Unauthorized | Verify Azure AD credentials          |
| 403         | Forbidden    | Check app permissions or user access |
| 404         | Not Found    | Verify site/drive/item IDs exist     |
| 429         | Rate Limited | Wait and retry                       |

### Common Issues

**"Site not found"** - The site ID format is `hostname,siteCollectionId,siteId`. Use Graph Explorer to find the correct format.

**"Access denied"** - The Azure AD app needs `Sites.Read.All` permission with admin consent.

**"Token expired"** - OAuth tokens expire after 1 hour. Use `ensureAccessToken` to refresh.

## External Resources

<CardGroup cols={2}>
  <Card title="Microsoft Graph Files API" icon="book" href="https://learn.microsoft.com/en-us/graph/api/resources/driveitem">
    Official API documentation
  </Card>

  <Card title="SharePoint Sites API" icon="book" href="https://learn.microsoft.com/en-us/graph/api/resources/site">
    Site operations reference
  </Card>

  <Card title="Graph Explorer" icon="flask" href="https://developer.microsoft.com/en-us/graph/graph-explorer">
    Test API calls interactively
  </Card>

  <Card title="Knowledges SharePoint Connector" icon="database" href="/products/ai-knowledge/connectors">
    Document sync and PBAV for Knowledges
  </Card>
</CardGroup>