Dropbox

🚀 dbx-mcp-server

A Model Context Protocol (MCP) server that integrates with Dropbox, allowing MCP-compatible clients to interact via Dropbox's public API through a set of powerful tools.

⚠️ Important Note

This project is not endorsed, obtained, or sponsored by Dropbox. It is an independent integration that works with Dropbox's public API.

Table of Contents

• Quick Start
• Installation
• Authentication
• Available Tools
• Configuration
• Usage Examples
• Testing
• Development
• License

🚀 Quick Start

1. Clone the repository.
2. Run npm install to install dependencies.
3. Run npm run build to build the project.
4. Register a Dropbox app in the Dropbox App Console:
   • Select the "Scoped access" API.
   • Choose the access type your app requires.
   • Name your app and click "Continue".
   • Add a callback URL (e.g., http://localhost:3000/callback).
5. Obtain the generated app key and secret, and add them to the dropbox.json file:

   {
     "DROPBOX_APP_KEY": "your-app-key",
     "DROPBOX_APP_SECRET": "your-app-secret"
   }
   

6. Install and run the MCP proxy to start using.

📦 Installation

git clone [repository-url]
cd dbx-mcp-server
npm install

🔑 Authentication

This server uses the OAuth 2.0 standard for authentication, specifically implementing the AUTHORIZATION_CODE grant type. Supported scopes include file and directory access permissions.

✨ Features

• Simplifies interaction with the Dropbox API.
• Provides a unified authentication flow.
• Supports multiple user authentication methods.

💻 Available Tools

Basic Usage

// Upload a file
async function uploadFile(filePath: string, content: Buffer): Promise<void> {
  const dbx = new DropboxClient();
  await dbx.files.upload(filePath, content);
}

// Download a file
async function downloadFile(filePath: string): Promise<Buffer> {
  const dbx = new DropboxClient();
  return await dbx.files.download(filePath);
}

Advanced Usage

// Create a directory
async function createDirectory(directoryPath: string): Promise<void> {
  const dbx = new DropboxClient();
  await dbx.files.createFolder(directoryPath);
}

// Delete a directory
async function deleteDirectory(directoryPath: string): Promise<void> {
  const dbx = new DropboxClient();
  await dbx.files.deleteFolder(directoryPath);
}

// Share a file
async function shareFile(filePath: string): Promise<string> {
  const dbx = new DropboxClient();
  return await dbx.sharing.createShare(filePath);
}

// Restore a shared file
async function restoreSharedFile(shareId: string): Promise<Buffer> {
  const dbx = new DropboxClient();
  return await dbx.sharing.revoke(shareId);
}

⚙️ Configuration

Environment Variables

# Recommended settings
export DROPBOX_APP_KEY="your-app-key"
export DROPBOX_APP_SECRET="your-app-secret"

Application Configuration File

Create a config.json file:

{
  "dropbox": {
    "appKey": "your-app-key",
    "appSecret": "your-app-secret"
  }
}

💻 Usage Examples

Basic Usage

import { DropboxClient } from './dbx-mcp-server';

async function main() {
  const dbx = new DropboxClient();
  
  // Upload a local file
  await dbx.files.upload('/uploads/test.txt', fs.readFileSync('test.txt'));
  
  // Download a remote file
  const content = await dbx.files.download('/uploads/test.txt');
  console.log(content.toString());
}

main().catch(console.error);

Advanced Usage

import { DropboxClient } from './dbx-mcp-server';

async function main() {
  const dbx = new DropboxClient();
  
  // Create a new directory
  await dbx.files.createFolder('/my-new-folder');
  
  // Delete a directory
  await dbx.files.deleteFolder('/my-empty-folder');
}

🧪 Testing

Run tests quickly

npm test

Specify a test file

npm test tests/dropbox/search-delete.test.ts

Filter test descriptions

npm test -- -t "should search for files"

🛠️ Development

This server is built using the following technologies:

• TypeScript
• MCP SDK
• Dropbox SDK v10.34.0
• API Version: v2

📄 License

MIT License

Copyright (c) 2025 MCP Server Contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

1. The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
2. The Software is provided "as is", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and non-infringement.

Contributors

• [Your Name] - Initial implementation
• [Other Contributors]