Nylas Api MCP

🚀 Nylas API MCP Server (Experimental)

⚠️ Important Note

This project is in the experimental phase, aiming to explore the use of the Model Context Protocol (MCP) as a guide for Nylas API integration. It is not an official release and is only for learning and experimental purposes.

This project implements a Model Context Protocol (MCP) server based on the Nylas API. It provides developers with resources, tools, and prompts to help them understand and integrate email, calendar, and contact functions related to the Nylas API.

📚 What is MCP?

Model Context Protocol (MCP) is a standard for integrating data, tools, and prompts into AI applications. An MCP server can expose resources, tools, and prompts to AI applications, such as Claude Desktop, Cursor, and other MCP-compatible applications.

✨ Features

This MCP server offers the following features:

• Documentation Resources: Comprehensive documentation on Nylas API endpoints, authentication, and best practices.
• Code Examples: Ready-to-use code examples for various Nylas API operations in multiple programming languages (Node.js, Python, Java, Ruby, curl).
• Interactive Tools: Tools for generating authentication codes and code implementations for specific endpoints.
• Prompts: Pre-built prompts for common Nylas integration scenarios.

🚀 Quick Start

Dependencies

• Node.js version 18+
• npm package manager

Installation

1. Clone this repository.
2. Install dependencies.

npm install

3. Build the project.

npm run build

Running the MCP Server

Using Standard Input/Output (Direct Integration with MCP Clients)

npm start

Using HTTP and SSE (Remote Connection)

MCP_MODE=http npm start

By default, the HTTP server runs on port 3000. You can change this port by setting the PORT environment variable:

MCP_MODE=http PORT=8080 npm start

💻 Usage with MCP Clients

Claude Desktop

1. Start the MCP server in standard input/output mode.
2. In Claude Desktop, go to Settings > Servers.
3. Click "Add Server".
4. Select "Run a local command" and enter the command to start this server:

node /path/to/nylas-api-mcp/dist/index.js

5. Name it (e.g., "Nylas API").
6. After adding, you can use all Nylas API resources, tools, and prompts in Claude conversations.

Cursor

1. Start the MCP server in standard input/output mode.
2. Add a new MCP server setting in Cursor.
3. Configure it to use the following command:

node /path/to/nylas-api-mcp/dist/index.js

📦 Resources

This MCP server provides the following resources:

• General Documentation: An overview of Nylas API features.
• Authentication Guide: How to authenticate with the Nylas API.
• API Endpoints: Documentation for email, calendar, and contact-related endpoints.
• Code Examples: Examples of implementing Nylas API operations in different programming languages.

📁 Project Structure

The root directory of the project contains the following main files and folders:

• index.js: The main application entry point.
• package.json: Configuration for project dependencies and scripts.
• public/: Static resources, such as HTML, CSS, and JavaScript files.
• src/: Source code files, including server logic and route handling.

🚀 Installation and Running

Clone the Repository

git clone [Repository URL]
cd nylas-api-mcp

Install Dependencies

npm install

Build the Project

npm run build

Start the Server

Development Mode

npm start

Production Mode

npm run start:prod

⚙️ Configuration Options

• PORT: Specify the port on which the server runs, default is 3000.
• NODE_ENV: Set the environment mode, which can be development or production.

💻 Usage Examples

Sending an Email

Request Method

POST /api/send-email

Request Body

{
  "to": "recipient@example.com",
  "subject": "Test Email",
  "text": "This is a test email."
}

Getting Calendar Events

Request Method

GET /api/calendar/events

🤝 Contribution Guidelines

1. Fork the project to your own repository.
2. Create a feature branch and commit your changes.
3. Push your code and create a pull request.

📄 License

MIT