使用说明

项目简介

SharePoint MCP 服务器是一个基于 Model Context Protocol (MCP) 构建的后端应用，旨在桥接大型语言模型 (LLM) 应用（如 Claude）与 Microsoft SharePoint 平台。通过此服务器，用户可以使用自然语言查询和操作 SharePoint 站点中的文档、列表和其他内容，为 LLM 应用提供企业级知识库的访问能力。

主要功能点

浏览文档库：查看 SharePoint 文档库的内容结构。
访问列表数据：检索和操作 SharePoint 列表中的数据项。
获取文档内容：访问 SharePoint 文档的文本内容，支持多种文档格式（如 CSV, Excel, Word, PDF, TXT 等）。
SharePoint 搜索：在整个 SharePoint 站点范围内执行内容搜索。
创建列表项：向 SharePoint 列表添加新的数据项。
创建 SharePoint 站点: 支持通过工具创建新的 SharePoint 站点。
创建智能列表: 可以根据用途创建预定义schema的智能列表。
创建高级文档库: 创建具有高级元数据设置的文档库。
创建现代页面: 创建具有美观布局的 SharePoint 现代页面。

安装步骤

前提条件
- 确保已安装 Python 3.10 或更高版本。
- 确保可以访问目标 SharePoint 站点，并已完成 Azure AD 应用程序注册和权限配置（参考仓库 'docs/auth_guide.md'）。

安装

从 GitHub 安装（推荐）：

pip install git+https://github.com/DEmodoriGatsuO/sharepoint-mcp.git

或者，克隆仓库进行开发安装：

git clone https://github.com/DEmodoriGatsuO/sharepoint-mcp.git
cd sharepoint-mcp
pip install -e .

配置
- 复制配置文件模板并编辑 '.env' 文件：
```
cp .env.example .env
nano .env
```
- 在 '.env' 文件中填入您的 SharePoint 和 Azure AD 应用程序的配置信息，包括 'TENANT_ID', 'CLIENT_ID', 'CLIENT_SECRET', 'SITE_URL' 等。

运行配置检查和认证诊断工具 （可选，用于验证配置是否正确）

python config_checker.py
python auth-diagnostic.py

启动服务器
```
python server.py
```

服务器配置

以下 JSON 配置信息可以用于 MCP 客户端连接 SharePoint MCP 服务器。请根据实际情况调整 'command' 和 'args' 字段，确保命令能够正确启动服务器。

{
  "serverName": "SharePoint MCP Server",
  "command": "python",
  "args": [
    "src/server.py"
  ],
  "transports": [
    {
      "type": "stdio"
    }
  ]
}

配置参数说明:

'serverName': MCP 服务器的名称，可以自定义。
'command': 启动 MCP 服务器的命令，这里使用 'python' 解释器。
'args': 传递给 'python' 命令的参数，指定服务器启动脚本的路径 'src/server.py'。
'transports': 定义客户端与服务器通信的传输协议，这里配置为 'stdio'，即标准输入输出流。

注意: 请确保 MCP 客户端能够找到 Python 解释器以及 'src/server.py' 脚本的路径。如果您使用虚拟环境安装，请确保在启动 MCP 客户端时激活了相同的虚拟环境，或者使用 Python 解释器的完整路径。

基本使用方法

SharePoint MCP 服务器启动后，将监听 MCP 客户端的请求。客户端可以使用 MCP 协议定义的标准方法调用服务器提供的工具和资源，例如：

使用 'get_site_info' 工具获取 SharePoint 站点信息。
使用 'list_document_libraries' 工具列出文档库。
使用 'search_sharepoint' 工具在 SharePoint 中执行搜索。
使用 'get_document_content' 工具获取指定文档的内容。

详细的工具和资源列表及其使用方法，请参考仓库中的 'tools' 和 'resources' 目录下的代码及相关文档。

关键词