Skip to content

Commit 44c21ea

Browse files
committed
docs: Updates README.md
Signed-off-by: iosifache <hi@iosifache.me>
1 parent 661cf99 commit 44c21ea

2 files changed

Lines changed: 40 additions & 1 deletion

File tree

README.md

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,40 @@
1-
# Anna's Archive MCP
1+
# Anna's Archive MCP Server
2+
3+
[An MCP server](https://modelcontextprotocol.io/introduction) for searching and downloading documents from [Anna's Archive](https://annas-archive.org)
4+
5+
> [!NOTE]
6+
> Notwithstanding prevailing public sentiment regarding Anna's Archive, the platform serves as a comprehensive repository for automated retrieval of documents released under permissive licensing frameworks (including Creative Commons publications and public domain materials). This software does not endorse unauthorized acquisition of copyrighted content and should be regarded solely as a utility. Users are urged to respect the intellectual property rights of authors and acknowledge the considerable effort invested in document creation.
7+
8+
## Tools
9+
10+
- `search`: Search Anna's Archive for documents matching specified terms
11+
- `download`: Download a specific document that was previously returned by the `search` tool
12+
13+
## Requirements
14+
15+
- MCP client, such as [Claude Desktop](https://claude.ai/download)
16+
- [A donation to Anna's Archive](https://annas-archive.org/donate), which grants JSON API access
17+
- [An API key](https://annas-archive.org/faq#api)
18+
19+
## Setup
20+
21+
Download the appropriate binary from [the GitHub Releases section](https://github.com/iosifache/annas-mcp/releases) and integrate it into your MCP client. The environment should contain two variables:
22+
23+
- `ANNAS_SECRET_KEY`: The API key; and
24+
- `ANNAS_DOWNLOAD_PATH`: The path where the documents should be downloaded.
25+
26+
If you are using Claude Desktop, please consider the following example configuration:
27+
28+
```json
29+
"anna-mcp": {
30+
"command": "/Users/iosifache/Downloads/annas-mcp",
31+
"env": {
32+
"ANNAS_SECRET_KEY": "feedfacecafebeef",
33+
"ANNAS_DOWNLOAD_PATH": "/Users/iosifache/Downloads"
34+
}
35+
}
36+
```
37+
38+
## Demo
39+
40+
<img src="claude.png" width="600px"/>

claude.png

589 KB
Loading

0 commit comments

Comments
 (0)