DBX MCP Server

🚀 dbx-mcp-server

A server supporting the Model Context Protocol (MCP) that integrates with Dropbox, allowing MCP-compatible clients to interact with Dropbox through a powerful set of tools.

⚠️ Important Disclaimer

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

🚀 Quick Start

1. Clone the repository.
2. Install the dependencies.
3. Configure the environment variables.
4. Run the server.

📦 Installation

To install dbx-mcp-server, follow these steps:

npm install dbx-mcp-server

Or use yarn:

yarn add dbx-mcp-server

🔑 Authentication

OAuth-based Authentication

1. Configure the identity provider (e.g., Dropbox OAuth).
2. Implement the Authenticator interface.
3. Authenticate using the generated access token.

Key-based Authentication

Configure key-based authentication using the following environment variables:

DBX_APP_KEY=your_app_key
DBX_APP_SECRET=your_app_secret

🛠️ Available Tools

File Operations

• createFile(filePath: string, content: Buffer): Promise<void>
• readFile(filePath: string): Promise<Buffer>
• updateFile(filePath: string, content: Buffer): Promise<void>
• deleteFile(filePath: string): Promise<void>

Directory Operations

• createDirectory(directoryPath: string): Promise<void>
• listDirectory(directoryPath: string): Promise<string[]>
• removeDirectory(directoryPath: string): Promise<void>

⚙️ Configuration

Modify config.json to customize the server behavior:

{
  "port": 3000,
  "host": "localhost",
  "auth_provider": "dropbox"
}

💻 Usage Examples

Basic Usage

import { Dropbox } from 'dbx-mcp-server';

async function main() {
    const dbx = new Dropbox({
        accessToken: 'your_access_token'
    });
    
    await dbx.createFile('test.txt', Buffer.from('Hello, World!'));
    console.log('File created successfully');
}

main();

Advanced Usage

import { Dropbox } from 'dbx-mcp-server';

async function main() {
    const dbx = new Dropbox({
        accessToken: 'your_access_token'
    });
    
    const content = await dbx.readFile('test.txt');
    console.log(content.toString());
}

main();

🧪 Testing

Run Tests

Run all tests using the following command:

npm test

Or specify a particular test file:

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

Specify Test Descriptions

Run tests that match a specific description:

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

👨‍💻 Development

This project is built using the following technology stack:

• TypeScript
• Model Context Protocol SDK
• Dropbox SDK v10.34.0
• Dropbox API 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:

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.