Quip MCP Server

🚀 quip-mcp-server項目

本項目是一個用於與quip服務進行交互的MCP（Model Context Protocol）服務器。藉助它，你能夠通過HTTP接口調用各類工具，對quip資源展開操作。

🚀 快速開始

本項目是一個MCP服務器，可與quip服務交互，通過HTTP接口調用工具操作quip資源。你可以按照以下安裝和配置步驟快速使用。

✨ 主要特性

• 提供與quip服務交互的HTTP接口。
• 支持多種工具操作quip資源，如獲取電子表格、更新表格數據等。
• 支持pip和uv兩種依賴管理方式進行安裝。

📦 安裝指南

使用 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協議。

💡 使用建議

• 在進行開發和測試時，請確保你已經正確配置了環境變量，特別是QUIP_TOKEN。
• 如果你要添加新工具，務必編寫單元測試，以保證工具的正確性和穩定性。

項目貢獻指南

歡迎社區貢獻！請參考貢獻指南瞭解如何參與。