mirror of
https://github.com/taigrr/elevenlabs-mcp.git
synced 2026-04-02 03:08:57 -07:00
add readme, funding
This commit is contained in:
2
.github/FUNDING.yml
vendored
Normal file
2
.github/FUNDING.yml
vendored
Normal file
@@ -0,0 +1,2 @@
|
||||
github: taigrr
|
||||
|
||||
28
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
28
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
@@ -0,0 +1,28 @@
|
||||
---
|
||||
name: Bug Report
|
||||
about: Report a bug in elevenlabs-mcp
|
||||
title: "[BUG]"
|
||||
labels: bug, Unlabeled
|
||||
assignees: taigrr
|
||||
---
|
||||
|
||||
**Please describe the issue.**
|
||||
[A clear and concise description of what the problem is.]
|
||||
|
||||
**Version Information**
|
||||
|
||||
- Commit [
|
||||
- Systems
|
||||
- OS Distribution: [ ]
|
||||
|
||||
**Does this bug exist on the tip of master?**
|
||||
[ ] Yes
|
||||
[ ] No
|
||||
|
||||
Please note that bugfixes will only be ported to previous major versions at the request of a Sponsor, and only when applicable and possible.
|
||||
It is recommended all elevenlabs-mcp users run the lastest stable release to take advantage of the newest features and bug fixes.
|
||||
|
||||
**Configuration**
|
||||
|
||||
Please upload the configuration files used if applicable.
|
||||
|
||||
5
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
5
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
@@ -0,0 +1,5 @@
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: Community Support
|
||||
url: https://discord.gg/FWvDANDvaP
|
||||
about: Please ask and answer questions here.
|
||||
17
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
17
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
@@ -0,0 +1,17 @@
|
||||
---
|
||||
name: Feature request
|
||||
about: Suggest an idea for elevenlabs-mcp
|
||||
title: "[FEAT]"
|
||||
labels: enhancement, Unlabeled
|
||||
assignees: taigrr
|
||||
---
|
||||
|
||||
**Is your feature request related to a problem? Please describe.**
|
||||
A clear and concise description of what the problem is. Ex. My organization needs [...]
|
||||
|
||||
**Describe the solution you'd like**
|
||||
A clear and concise description of what you want to happen.
|
||||
|
||||
**Additional context**
|
||||
Add any other context or screenshots about the feature request here.
|
||||
|
||||
89
README.md
89
README.md
@@ -1,71 +1,64 @@
|
||||
# ElevenLabs MCP Server
|
||||
# elevenlabs-mcp
|
||||
[](https://opensource.org/licenses/0BSD)
|
||||
[](https://godoc.org/github.com/taigrr/elevenlabs-mcp)
|
||||
[](https://goreportcard.com/report/github.com/taigrr/elevenlabs-mcp)
|
||||
|
||||
An MCP (Model Context Protocol) server that provides text-to-speech capabilities using ElevenLabs API.
|
||||
An MCP (Model Context Protocol) server that bridges AI assistants with ElevenLabs text-to-speech capabilities.
|
||||
|
||||
## Features
|
||||
This server is not affiliated with, nor associated with ElevenLabs in any way.
|
||||
|
||||
- **say**: Convert text to speech and save as MP3 file
|
||||
- **read**: Read a text file and convert it to speech
|
||||
- **play**: Play audio files using the beep library
|
||||
- **set_voice**: Change the voice used for generation (memory only)
|
||||
- **get_voices**: List available voices and show currently selected one
|
||||
- **history**: List available audio files with text summaries
|
||||
## Purpose
|
||||
|
||||
## Setup
|
||||
This MCP server enables AI assistants to generate speech from text using the ElevenLabs API.
|
||||
It provides a seamless interface for converting text to high-quality speech, managing voice selection, and handling audio playback within MCP-compatible environments.
|
||||
|
||||
1. Get your ElevenLabs API key from [ElevenLabs](https://elevenlabs.io)
|
||||
2. Set the environment variable:
|
||||
```bash
|
||||
export XI_API_KEY=your_api_key_here
|
||||
```
|
||||
As a prerequisite, you must already have an account with [ElevenLabs](https://elevenlabs.io).
|
||||
After creating your account, you can get your API key [from here](https://help.elevenlabs.io/hc/en-us/articles/14599447207697-How-to-authorize-yourself-using-your-xi-api-key-).
|
||||
|
||||
## Build
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
go build -o elevenlabs-mcp
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
The server runs via stdio and communicates using the MCP protocol:
|
||||
## Configuration
|
||||
|
||||
Set your ElevenLabs API key:
|
||||
```bash
|
||||
export XI_API_KEY=your_api_key_here
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
The server communicates via stdio using the MCP protocol:
|
||||
|
||||
```bash
|
||||
./elevenlabs-mcp
|
||||
```
|
||||
|
||||
## Tools
|
||||
Generated audio files are automatically saved to `.xi/<timestamp>-<hex5>.mp3` with corresponding `.txt` files containing the original text for reference.
|
||||
|
||||
### say
|
||||
Convert text to speech and save as MP3.
|
||||
- **text** (string, required): Text to convert to speech
|
||||
## MCP Tools
|
||||
|
||||
### read
|
||||
Read a text file and convert it to speech.
|
||||
- **file_path** (string, required): Path to the text file
|
||||
The server provides the following tools to MCP clients:
|
||||
|
||||
### play
|
||||
Play an audio file.
|
||||
- **file_path** (string, required): Path to the audio file
|
||||
|
||||
### set_voice
|
||||
Change the voice used for generation.
|
||||
- **voice_id** (string, required): ID of the voice to use
|
||||
|
||||
### get_voices
|
||||
List all available voices and show the currently selected one.
|
||||
- No parameters required
|
||||
|
||||
### history
|
||||
List available audio files with text summaries.
|
||||
- No parameters required
|
||||
|
||||
## Audio Files
|
||||
|
||||
Generated audio files are saved to `.xi/<timestamp>-<hex5>.mp3` with corresponding `.txt` files containing the original text. Files can be replayed using the `play` tool.
|
||||
- **say** - Convert text to speech and save as MP3
|
||||
- **read** - Read a text file and convert it to speech
|
||||
- **play** - Play audio files using system audio
|
||||
- **set_voice** - Change the voice used for generation
|
||||
- **get_voices** - List available voices and show current selection
|
||||
- **history** - List previously generated audio files with text summaries
|
||||
|
||||
## Dependencies
|
||||
|
||||
- ElevenLabs API for text-to-speech generation
|
||||
- Beep library for audio playback
|
||||
- Mark3labs MCP-Go for MCP server functionality
|
||||
- [ElevenLabs API](https://elevenlabs.io) for text-to-speech generation
|
||||
- [Beep library](https://github.com/gopxl/beep) for audio playback
|
||||
- [MCP-Go](https://github.com/mark3labs/mcp-go) for MCP server functionality
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under the 0BSD License, written by [Rob Landley](https://github.com/landley).
|
||||
As such, you may use this library without restriction or attribution, but please don't pass it off as your own.
|
||||
Attribution, though not required, is appreciated.
|
||||
|
||||
By contributing, you agree all code submitted also falls under the License.
|
||||
Reference in New Issue
Block a user