Skip to content

Commit 2052711

Browse files
Copilotzackify
andcommitted
Update README.md with alpha note and new sections
Co-authored-by: zackify <[email protected]>
1 parent 527df45 commit 2052711

File tree

1 file changed

+41
-2
lines changed

1 file changed

+41
-2
lines changed

README.md

Lines changed: 41 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,23 @@
11
# revect
22

3-
open source version
3+
> **Note:** This project is currently in alpha release. Features and interfaces may change.
44
5-
# run
5+
## Current Features
6+
7+
- **Own your data**: everything is stored in a simple sqlite file
8+
- **Streaming HTTP MCP server**: index and recall information from any AI system, Claude desktop support
9+
10+
## Upcoming Features
11+
12+
- [ ] Browser extension to auto save or choose to save when right clicking on URLs and articles
13+
- [ ] Obsidian extension to pull in all content and search inside obsidian
14+
- [ ] Web interface to search more deeply and interact better with your data
15+
- [ ] Mobile apps for iOS and Android
16+
- [ ] More 3rd party integrations
17+
18+
## Getting Started
19+
20+
### Running with Docker
621

722
```
823
docker run \
@@ -16,3 +31,27 @@ docker run \
1631
--add-host=host.docker.internal:host-gateway \
1732
zachrebuild/revect.io:6
1833
```
34+
35+
### MCP Setup
36+
37+
To use revect with the MCP (Model Context Protocol) for AI integrations:
38+
39+
1. Install the mcp-remote package:
40+
```bash
41+
npm install @modelcontextprotocol/mcp-remote
42+
```
43+
44+
2. Connect to your running revect instance:
45+
```javascript
46+
// In your client code
47+
import { createClient } from '@modelcontextprotocol/mcp-remote';
48+
49+
const client = createClient({
50+
url: 'http://localhost:3009', // Your revect server URL
51+
apiSecret: 'test' // Same as API_SECRET in docker setup
52+
});
53+
54+
// Now you can use client to access revect functionality
55+
// Example: Search in your database
56+
const results = await client.tool('semantic-search', { text: 'your search query' });
57+
```

0 commit comments

Comments
 (0)