使用说明

项目简介

SharePoint MCP Server 是一个基于 Model Context Protocol (MCP) 构建的后端服务，旨在为大型语言模型 (LLM) 应用提供访问企业 SharePoint 内容的能力。通过此服务器，LLM 可以安全、便捷地检索 SharePoint 文档、执行搜索，并进行其他与 SharePoint 相关的操作，从而扩展 LLM 在企业知识库和协作场景中的应用。

主要功能点

资源访问: 将 SharePoint 网站、文档库、文件夹和文档内容以 MCP 资源的形式暴露给 LLM 客户端，支持按 URI 标准化访问和检索。
文档搜索: 提供工具 (Tool) 功能，允许 LLM 客户端通过关键词在 SharePoint 中搜索文档，并获取文档的基本信息。
文档内容获取: 支持获取多种文档格式的内容，包括 Office 文档、文本文件、PDF 等，使 LLM 能够读取和理解文档内容。
常用 Prompt 模板: 内置了针对 SharePoint 场景的 Prompt 模板，例如文档摘要、相关文档查找、文件夹内容探索等，方便快速构建基于 SharePoint 数据的 LLM 应用。
易于部署和配置: 提供 Docker 和 Bun 两种部署方式的配置示例，方便用户快速搭建和集成。

安装步骤

克隆仓库

git clone https://github.com/BrianCusack/mcpsharepoint.git
cd mcpsharepoint

安装依赖 如果使用 Bun (推荐):
```
bun install
```
如果使用 Docker，请确保已安装 Docker 环境。
配置环境变量
- 复制 '.env.example' 文件并重命名为 '.env'。
- 根据您的 SharePoint 环境，填写 '.env' 文件中的以下字段：
  - 'TENANT_ID': 您的 Azure 租户 ID
  - 'CLIENT_ID': 已在 Azure AD 中注册的应用的客户端 ID
  - 'CLIENT_SECRET': 已注册应用的客户端密钥
  - 'SITE_ID': 您的 SharePoint 站点的 ID

服务器配置

以下是 MCP 客户端 (如 Claude Desktop) 配置 SharePoint MCP Server 的 JSON 示例。请根据您选择的部署方式选择相应的配置。

Docker 部署配置

{
  "mcpServers": {
    "sharepoint": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "--init",
        "-e", "DOCKER_CONTAINER=true",
        "-e", "TENANT_ID=your-tenant-id",  // 替换为您的 Azure 租户 ID
        "-e", "CLIENT_ID=your-client-id",  // 替换为您的 Azure 应用客户端 ID
        "-e", "CLIENT_SECRET=your-client-secret", // 替换为您的 Azure 应用客户端密钥
        "-e", "SITE_ID=your-site-id",    // 替换为您的 SharePoint 站点 ID
        "mcp/sharepoint"
      ]
    }
  }
}

Bun 部署配置

{
  "mcpServers": {
    "sharepoint": {
      "command": "bun",
      "args": ["run", "start"],
      "env": {
        "TENANT_ID": "your-tenant-id",  // 替换为您的 Azure 租户 ID
        "CLIENT_ID": "your-client-id",  // 替换为您的 Azure 应用客户端 ID
        "CLIENT_SECRET": "your-client-secret", // 替换为您的 Azure 应用客户端密钥
        "SITE_ID": "your-site-id"    // 替换为您的 SharePoint 站点 ID
      }
    }
  }
}

配置说明:

'server name': 'sharepoint' (可自定义，用于在 MCP 客户端中标识此服务器)
'command': 启动 MCP 服务器的命令，Docker 部署为 'docker'，Bun 部署为 'bun'
'args': 命令参数，Docker 部署为 'docker run ...' 的参数列表，Bun 部署为 'bun run start' 的参数列表，环境变量通过 '-e' 或 'env' 传递。
'env': (仅 Bun 部署) 环境变量配置，用于传递 SharePoint 连接所需的身份验证信息。

注意: 请务必将 'your-tenant-id', 'your-client-id', 'your-client-secret', 'your-site-id' 替换为您的实际 SharePoint 环境配置。

基本使用方法

启动 MCP 服务器: 根据您选择的部署方式，运行相应的启动命令 (例如 'bun run start' 或 Docker 启动命令)。
配置 MCP 客户端: 将上述 JSON 配置添加到您的 MCP 客户端 (如 Claude Desktop) 的配置文件中。
在 MCP 客户端中使用: MCP 客户端连接到 SharePoint MCP Server 后，您可以使用以下功能：
- 资源 URI: 在 LLM Prompt 中使用 'sharepoint://' 开头的 URI 访问 SharePoint 资源，例如 'sharepoint://sites' 获取站点列表, 'sharepoint://document/{documentId}' 获取文档内容。
- 工具 (Tools): 调用 'search-documents' 工具搜索 SharePoint 文档。
- Prompt 模板: 使用预定义的 'document-summary', 'find-relevant-documents', 'explore-folder' 等 Prompt 模板，快速实现 SharePoint 相关的功能。

请参考 MCP 客户端的文档，了解如何在 Prompt 中有效利用 MCP 服务器提供的资源、工具和 Prompt 模板。

关键词