Sentry MCP Server 21w

🚀 Sentry MCP Server Guide

This guide provides a comprehensive introduction to the Sentry MCP server, including installation steps, configuration details, and usage instructions. It aims to help users quickly get started with the server and make the most of its features.

🚀 Quick Start

1. Start the Server

Run the following command to start the service:

npm start

By default, the server will run on http://localhost:3000.

2. Access the API Documentation

Open your browser and visit http://localhost:3000/docs to view the Swagger UI documentation.

✨ Features

1. Installation

npm install sentry-mcp-server --save

2. Initialization

Initialize the module in your project:

const SentryMCP = require('sentry-mcp-server');
SentryMCP.init({
    public: 'your_sentry_public_key',
    private: 'your_sentry_private_key',
    project: 'your_project_slug'
});

📦 Installation Guide

1. Clone the Repository

Use Git to clone the project repository:

git clone https://github.com/srcgrp/sentry-mcp-server.git
cd sentry-mcp-server

2. Install Dependencies

After entering the project directory, install the required dependencies:

npm install

3. Configure Environment Variables

Create and edit the .env file:

PORT=3000
SENTRY_PUBLIC_KEY=your_sentry_public_key
SENTRY_PRIVATE_KEY=your_sentry_private_key
SENTRY_PROJECT_slug=your_project_slug

📚 Documentation

Configuration

1. Modify the Configuration File

Edit the config.json file:

{
    "port": 3000,
    "sentry": {
        "publicKey": "your_sentry_public_key",
        "privateKey": "your_sentry_private_key",
        "projectSlug": "your_project_slug"
    }
}

2. Set Up a Proxy

Add a reverse proxy configuration to nginx.conf:

server {
    listen 80;
    server_name your_domain;

    location / {
        proxy_pass http://localhost:3000;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
    }
}

Usage Instructions

1. Get Help

Access the documentation page:

npm run docs

2. Submit Code

When submitting code to the repository, please ensure that you follow the guidelines in the CONTRIBUTING.md file.

👥 Contributors

All contributors are welcome to participate in the project! Please refer to the CONTRIBUTING.md file to learn how to contribute code.

🛠️ Support

If you need support or encounter any issues, please visit our Discussions page to provide feedback.

Thank you for your support of the Sentry MCP server! We hope this tool will bring convenience to your project.