Quip MCP Server

🚀 Quip MCP Server

This project is an MCP (Model Context Protocol) server designed to interact with the Quip service. It enables users to operate Quip resources by invoking various tools through HTTP interfaces.

🚀 Quick Start

The Quip MCP Server allows you to interact with Quip services via HTTP interfaces. To get started, follow the installation and configuration steps below.

✨ Features

• Interact with Quip services via HTTP interfaces.
• Multiple installation methods are supported.
• A variety of tools are provided to operate Quip resources.

📦 Installation

Install with pip

You can install it directly using pip:

pip install quip-mcp-server

Install with uv

If you use uv for dependency management, you can install it with the following command:

uv pip install quip-mcp-server

📚 Documentation

Configuration Guide

Environment Variable Configuration

Create a .env file (or copy .env.example) and modify the content as needed:

# Required: Quip API access token
QUIP_TOKEN=your_quip_api_token_here

# Optional: Default storage provider (Options: filesystem, s3)
DEFAULT_STORAGE_PROVIDER=filesystem

# Optional: File system storage path
FILESYSTEM_STORAGE_PATH=/path/to/storage/files

# Optional: S3 storage configuration (if s3 is selected as the storage provider)
S3_BUCKET_NAME=your_s3_bucket_name
S3_ENDPOINT_URL=http://localhost:9000  # If using local minio
AWS_REGION=us-east-1

Tool List

The following are the currently implemented tools:

1. quip/list_spreadsheets - Get all spreadsheets of the user

# Basic Usage
mcp quip list_spreadsheets --auth your_api_token

# Optional parameter:
# --all-users: Show spreadsheets of all users (administrator privileges required)
mcp quip list_spreadsheets --auth your_api_token --all-users

2. quip/get_sheet - Get the content of a specific spreadsheet

# Basic Usage
mcp quip get_sheet --auth your_api_token --sheet-id sheet_id_here

3. quip/update_sheet - Update data in a spreadsheet

# Basic Usage
mcp quip update_sheet --auth your_api_token --sheet-id sheet_id_here \
--data '{"key1":"value1", "key2":"value2"}'

Development Guide

Project Structure

The project directory structure is as follows:

quip-mcp-server/
├── src/
│   ├── __init__.py
│   ├── server.py       # Main MCP server implementation
│   ├── quip_client.py  # Quip API client
│   ├── tools.py        # Tool definition and handlers
│   └── storage.py      # Storage abstraction and implementation
├── tests/
│   ├── __init__.py
│   ├── test_server.py  # Server unit tests
│   ├── test_storage.py # Storage module unit tests
│   └── e2e/            # End-to-end tests
│       ├── __init__.py
│       ├── conftest.py # Test fixtures
│       └── test_quip_integration.py # Integration tests with Quip API
├── .uv/
│   └── config.toml     # uv configuration settings
├── pyproject.toml      # Project metadata and dependencies (including pytest configuration)
├── uvproject.yaml      # uv-specific project configuration
├── uv.lock             # Locked dependencies
├── .python-version     # Python version specification
├── .env.example        # Environment variable example
└── README.md           # Project documentation

Development Environment Setup

Install Dependencies

Install using pip:

pip install -r requirements.txt

Or install using uv:

uv develop quip-mcp-server

Start the Server

You can start the server with the following command:

python src/server.py

Testing Guide

Unit Tests

Run all unit tests:

pytest tests/

Or specify a particular test file:

pytest tests/test_server.py -v

End-to-End Tests

Run integration tests (Quip API access is required):

pytest tests/e2e/ --auth your_api_token

Add New Tools

To add a new Quip tool, follow these steps:

1. Define a new tool class in tools.py.
2. Register the tool in server.py.
3. Implement the corresponding business logic.
4. Write unit tests and submit them.

Dependency Management Guide

Install with pip

pip install quip-mcp-server

Or specify a version:

pip install quip-mcp-server==1.0.0

Install with uv

uv pip install quip-mcp-server

Contribution Guide

Community contributions are welcome! Please refer to the Contribution Guide to learn how to get involved.

📄 License

This project is licensed under the MIT License.