项目概述

这个项目是一个用于与quip服务进行交互的MCP（Model Context Protocol）服务器。它允许通过HTTP接口调用各种工具来操作quip资源。

安装指南

使用 pip 安装

你可以使用pip直接安装：

pip install quip-mcp-server

使用uv 安装

如果你使用uv进行依赖管理，可以通过以下命令安装：

uv pip install quip-mcp-server

配置指南

环境变量配置

创建一个.env文件（或复制.env.example）并根据需要修改内容：

# 必填：quip API的访问令牌
QUIP_TOKEN=your_quip_api_token_here

# 可选：默认存储提供商（可选：filesystem, s3）
DEFAULT_STORAGE_PROVIDER=filesystem

# 可选：文件系统存储路径
FILESYSTEM_STORAGE_PATH=/path/to/storage/files

# 可选：S3存储配置（如果选择了s3作为存储提供程序）
S3_BUCKET_NAME=your_s3_bucket_name
S3_ENDPOINT_URL=http://localhost:9000  # 如果使用本地minio
AWS_REGION=us-east-1

工具列表

以下是当前实现的工具：

1. quip/list_spreadsheets - 获取用户的所有电子表格

# 基本用法
mcp quip list_spreadsheets --auth your_api_token

# 可选参数：
# --all-users：显示所有用户的电子表格（需要管理员权限）
mcp quip list_spreadsheets --auth your_api_token --all-users

2. quip/get_sheet - 获取特定电子表格的内容

# 基本用法
mcp quip get_sheet --auth your_api_token --sheet-id sheet_id_here

3. quip/update_sheet - 更新电子表格中的数据

# 基本用法
mcp quip update_sheet --auth your_api_token --sheet-id sheet_id_here \\
--data '{"key1":"value1", "key2":"value2"}'

开发指南

项目结构

项目的目录结构如下：

quip-mcp-server/
├── src/
│   ├── __init__.py
│   ├── server.py       # 主MCP服务器实现
│   ├── quip_client.py  # Quip API客户端
│   ├── tools.py        # 工具定义与处理程序
│   └── storage.py      # 存储抽象与实现
├── tests/
│   ├── __init__.py
│   ├── test_server.py  # 服务器单元测试
│   ├── test_storage.py # 存储模块单元测试
│   └── e2e/            # 端到端测试
│       ├── __init__.py
│       ├── conftest.py # 测试 fixtures
│       └── test_quip_integration.py # 与Quip API的集成测试
├── .uv/
│   └── config.toml     # uv配置设置
├── pyproject.toml      # 项目元数据与依赖项（包含 pytest 配置）
├── uvproject.yaml      # uv专用项目配置
├── uv.lock             # 锁定的依赖项
├── .python-version     # Python版本规范
├── .env.example        # 环境变量示例
└── README.md           # 项目说明文档

开发环境设置

安装依赖项

使用 pip 安装：

pip install -r requirements.txt

或使用uv安装：

uv develop quip-mcp-server

启动服务器

你可以通过以下命令启动服务器：

python src/server.py

测试指南

单元测试

运行所有单元测试：

pytest tests/

或指定特定测试文件：

pytest tests/test_server.py -v

端到端测试

运行集成测试（需要quip API访问权限）：

pytest tests/e2e/ --auth your_api_token

添加新工具

要添加新的quip工具，请按照以下步骤操作：

1. 在tools.py中定义新的工具类。
2. 在server.py中注册该工具。
3. 实现相应的业务逻辑。
4. 编写单元测试并提交。

依赖管理指南

使用pip安装

pip install quip-mcp-server

或指定版本：

pip install quip-mcp-server==1.0.0

使用uv安装

uv pip install quip-mcp-server

项目贡献指南

欢迎社区贡献！请参考贡献指南了解如何参与。

许可证

本项目遵守MIT License协议。