Dbx MCP Server

🚀 dbx-mcp-server

A Model Context Protocol (MCP) server integrated with Dropbox, allowing compatible clients to interact with Dropbox through a set of powerful tools.

⚠️ Important Note

This project is not officially approved, supported, or sponsored. 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 desired app access type.
   • Name your app and click "Create app".
   • In the "Permissions" section, select the required permissions:
     • files.metadata.read
     • files.content.read
     • files.content.write
     • sharing.write
     • account_info.read
   • Add http://localhost:3000/callback as the redirect URI.
   • Record your app key and secret key.
5. Run the setup script:

   npm run setup
   

6. Configure the MCP client.

📦 Installation

The project is built using the following technologies:

• TypeScript
• Model Context Protocol SDK
• Dropbox SDK v10.34.0
• Dropbox API v2

🔑 Authentication

The app communicates with Dropbox via OAuth 2.0. Here are the steps:

1. Initialize the OAuth client:

   const dbx = new DropboxClient({
     clientId: DROPBOX_CLIENT_ID,
     clientSecret: DROPBOX_CLIENT_SECRET,
     redirectUri: REDIRECT_URI
   });
   

2. Get the authorization URL:

   const authorizeUrl = await dbx.authorizeAsync();
   

3. Handle the callback and get the access token:

   const { accessToken } = await dbx.getAccessToken(redirect_response);
   

🛠️ Available Tools

File Operations

• dbx.filesCreateV2/commit: Create a new file or overwrite an existing one.
• dbx.filesReadV2/chunked: Read file content in chunks.
• dbx.filesDeleteV2/sync: Delete a file synchronously.
• dbx.delta.sync: Get file modification records.

Directory Operations

• dbx.usersGetCurrentAccount: Get the current user information.
• dbx.groupsCreateSubgroup: Create a subgroup.
• dbx.sharingShareFolder: Share a folder.
• dbx.sharingRevokeAccess: Revoke access permissions.

⚙️ Configuration

Environment Variables

Set the following environment variables:

DROPBOX_CLIENT_ID=your_client_id
DROPBOX_CLIENT_SECRET=your_client_secret
REDIRECT_URI=http://localhost:3000/callback

Proxy Configuration

If you need to access Dropbox through a proxy, add proxy information during initialization:

const transport = newHttps.Agent({
   proxy: {
     host: 'proxy.example.com',
     port: 8080,
     credentials: {
       user: 'proxy-user',
       password: 'proxy-password'
     }
   }
});

const dbx = new DropboxClient({ 
   clientId: DROPBOX_CLIENT_ID,
   clientSecret: DROPBOX_CLIENT_SECRET,
   redirectUri: REDIRECT_URI,
   transport
});

💻 Usage Examples

Upload a File

async function uploadFile(filePath, fileName) {
   const fileBuffer = await fs.readFile(filePath);
   const response = await dbx.filesCreateV2/commit({
     path: fileName,
     contents: { buffer: fileBuffer },
     mode: 'overwrite'
   });
   return response;
}

Download a File

async function downloadFile(filePath, fileName) {
   const response = await dbx.filesReadV2/chunked({ 
     path: filePath,
     maxBytes: 1024 * 1024 // Read 1MB at a time
   });
   return response;
}

🧪 Testing

Run Tests

Use Jest to run tests:

npm test

👨‍💻 Development

The project uses the following tools:

• TypeScript: Define file types and provide autocompletion.
• @dropbox/dropbox-node-sdk: A Node.js library for accessing the Dropbox API.
• Jest: For unit and integration testing.
• ESLint: Code style checking.
• Prettier: Code formatting.

📄 License

This project is licensed under the 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:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

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 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.