Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
76 lines (54 loc) · 1.95 KB

CONTRIBUTING.md

File metadata and controls

76 lines (54 loc) · 1.95 KB
Raw

Contributing

Thank you for your interest in contributing to the MCP Go SDK! We welcome contributions of all kinds, including bug fixes, new features, and documentation improvements. This document outlines the process for contributing to the project.

Development Guidelines

Prerequisites

Make sure you have Go 1.23 or later installed on your machine. You can check your Go version by running:

go version

Setup

  1. Fork the repository

  2. Clone your fork:

     git clone https://github.com/YOUR_USERNAME/mcp-go.git
 cd mcp-go

  3. Install the required packages:

    go mod tidy

Workflow

  1. Create a new branch.

  2. Make your changes.

  3. Ensure you have added tests for any new functionality.

  4. Run the tests as shown below from the root directory:

    go test -v './...'

    The otel submodule has its own go.mod. To test it:

    cd otel && go test -v './...'

  5. Submit a pull request to the main branch.

Releasing

The repository contains two Go modules:

  • github.com/mark3labs/mcp-go (root) — core, no OpenTelemetry deps.
  • github.com/mark3labs/mcp-go/otel — OpenTelemetry adapter, has its own go.mod.

Tag the core module first, then bump otel/go.mod's require line to the new core tag (replacing the replace directive used during development), then tag the submodule:

# 1. Tag the core
git tag v0.X.Y
git push origin v0.X.Y

# 2. Bump otel/go.mod and remove the replace directive
cd otel
go mod edit -require=github.com/mark3labs/mcp-go@v0.X.Y -dropreplace=github.com/mark3labs/mcp-go
go mod tidy

# 3. Commit and tag the submodule
git commit -am "otel: pin core to v0.X.Y"
git tag otel/v0.X.Y
git push origin otel/v0.X.Y

Feel free to reach out if you have any questions or need help either by opening an issue or by reaching out in the Discord channel.