|
| 1 | +<!-- omit from toc --> |
| 2 | +# Wordle MCP |
| 3 | + |
| 4 | +[](https://codespaces.new/cr2007/mcp-wordle) |
| 5 | + |
| 6 | +A MCP Server for fetching the Wordle solutions via the Wordle API. |
| 7 | + |
| 8 | +> ![NOTE] |
| 9 | +> Wordle solutions are only available from 2021-05-19, to 23 days in the future. |
| 10 | +> Any other attempts at calling other dates will return an error from the API |
| 11 | +
|
| 12 | +<!-- omit from toc --> |
| 13 | +# Index |
| 14 | +- [Get Started](#get-started) |
| 15 | + - [Using Docker (recommended)](#using-docker-recommended) |
| 16 | + - [Installing via `uvx`](#installing-via-uvx) |
| 17 | +- [Examples on Claude Desktop](#examples-on-claude-desktop) |
| 18 | +- [Contributing](#contributing) |
| 19 | + |
| 20 | +--- |
| 21 | + |
| 22 | +# Get Started |
| 23 | + |
| 24 | +## Using Docker (recommended) |
| 25 | + |
| 26 | +Ensure that you have [Docker](https://www.docker.com) installed.<br> |
| 27 | +Add this to your MCP Server configuration: |
| 28 | + |
| 29 | +```json |
| 30 | +{ |
| 31 | + "mcpServers": { |
| 32 | + "mcp-local-rag": { |
| 33 | + "command": "docker", |
| 34 | + "args": [ |
| 35 | + "run", |
| 36 | + "--rm", |
| 37 | + "-i", |
| 38 | + "--init", |
| 39 | + "-e", |
| 40 | + "DOCKER_CONTAINER=true", |
| 41 | + "ghcr.io/cr2007/mcp-wordle:latest" |
| 42 | + ] |
| 43 | + } |
| 44 | + } |
| 45 | +} |
| 46 | +``` |
| 47 | + |
| 48 | +> [!IMPORTANT] |
| 49 | +> If you get an error on Claude Desktop for the first time, just make sure to pull the image before running. |
| 50 | +> `docker pull ghcr.io/cr2007/mcp-wordle:latest` |
| 51 | +
|
| 52 | +## Installing via `uvx` |
| 53 | + |
| 54 | +The quickest and easiest method to get started. Make sure to install [`uv`](https://docs.astral.sh/uv) before adding this in your configuration.<br> |
| 55 | +Add this to your MCP server configuration: |
| 56 | + |
| 57 | +```json |
| 58 | +{ |
| 59 | + "mcpServers": { |
| 60 | + "mcp-local-rag":{ |
| 61 | + "command": "uvx", |
| 62 | + "args": [ |
| 63 | + "--from", |
| 64 | + "git+https://github.com/cr2007/mcp-wordle", |
| 65 | + "mcp-wordle" |
| 66 | + ] |
| 67 | + } |
| 68 | + } |
| 69 | +} |
| 70 | +``` |
| 71 | + |
| 72 | +# Examples on Claude Desktop |
| 73 | + |
| 74 | +<div align="center"> |
| 75 | + <img width=75%, src="./images/Claude_Chat-Example.png"> |
| 76 | +</div> |
| 77 | + |
| 78 | +# Contributing |
| 79 | + |
| 80 | +Contributions are welcome! You may [fork](https://github.com/cr2007/mcp-wordle/fork) the repo, create your changes in a branch, and then create a [Pull Request](https://github.com/cr2007/mcp-wordle/compare) |
0 commit comments