Skip to content

Commit 1272fcd

Browse files
committed
docs
Signed-off-by: Carlos Alexandro Becker <caarlos0@users.noreply.github.com>
1 parent 96dee32 commit 1272fcd

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
<p align="center">
2+
<img alt="GoReleaser Logo" src="https://avatars2.githubusercontent.com/u/24697112?v=3&s=200" height="200" />
3+
<h3 align="center">GoReleaser MCP</h3>
4+
<p align="center">Model Context Protocol server for GoReleaser.</p>
5+
</p>
6+
7+
---
8+
9+
A Model Context Protocol (MCP) server for GoReleaser.
10+
Provides tools and documentation to help AI assistants understand and work with
11+
GoReleaser configurations.
12+
13+
---
14+
15+
## Features
16+
17+
- **Configuration Validation**: Check GoReleaser configurations for errors and deprecated options
18+
- **Deprecation Fixes**: Get prompted to fix deprecated configuration options with detailed instructions
19+
- **Embedded Documentation**: Access GoReleaser documentation directly through the MCP server
20+
- **Update Prompt**: Use the `update_config` prompt to modernize your GoReleaser configuration
21+
22+
## Installation
23+
24+
```bash
25+
go install github.com/goreleaser/goreleaser-mcp@latest
26+
npm -g @goreleaser/mcp
27+
```
28+
29+
## Usage
30+
31+
Run the MCP server:
32+
33+
```bash
34+
goreleaser-mcp
35+
```
36+
37+
The server communicates over stdio and implements the Model Context Protocol.
38+
39+
## Badges
40+
41+
[![Release](https://img.shields.io/github/release/goreleaser/goreleaser-mcp.svg?style=for-the-badge)](https://github.com/goreleaser/goreleaser-mcp/releases/latest)
42+
[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=for-the-badge)](/LICENSE.md)
43+
[![Build status](https://img.shields.io/github/actions/workflow/status/goreleaser/goreleaser-mcp/build.yml?style=for-the-badge&branch=main)](https://github.com/goreleaser/goreleaser-mcp/actions?workflow=build)
44+
[![Go Doc](https://img.shields.io/badge/godoc-reference-blue.svg?style=for-the-badge)](http://godoc.org/github.com/goreleaser/goreleaser-mcp)
45+
[![Powered By: GoReleaser](https://img.shields.io/badge/powered%20by-goreleaser-green.svg?style=for-the-badge)](https://github.com/goreleaser)
46+
[![GoReportCard](https://goreportcard.com/badge/github.com/goreleaser/goreleaser-mcp?style=for-the-badge)](https://goreportcard.com/report/github.com/goreleaser/goreleaser-mcp)

0 commit comments

Comments
 (0)