edoardo 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +137 -60
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,73 +1,150 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Edoardo
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
AI Agent with MCP (Model Context Protocol) plugin support. Chat with multiple AI models and extend capabilities with powerful plugins.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
## Installation
|
|
6
6
|
|
|
7
|
-
|
|
8
|
-
|
|
7
|
+
```bash
|
|
8
|
+
npm install -g edoardo
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Quick Start
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
# Start the application (opens browser automatically)
|
|
15
|
+
edoardo
|
|
16
|
+
|
|
17
|
+
# Start on a specific port
|
|
18
|
+
edoardo --port=8080
|
|
19
|
+
|
|
20
|
+
# Start without opening browser
|
|
21
|
+
edoardo --no-open
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## CLI Options
|
|
25
|
+
|
|
26
|
+
| Option | Description |
|
|
27
|
+
|--------|-------------|
|
|
28
|
+
| `--port=<number>` | Set the server port (default: 3001) |
|
|
29
|
+
| `--no-open` | Don't open browser automatically |
|
|
30
|
+
| `--help`, `-h` | Show help message |
|
|
9
31
|
|
|
10
|
-
##
|
|
32
|
+
## Supported LLM Providers
|
|
11
33
|
|
|
12
|
-
|
|
34
|
+
| Provider | Models | API Key Required |
|
|
35
|
+
|----------|--------|------------------|
|
|
36
|
+
| **OpenAI** | GPT-4o, GPT-4o-mini, GPT-4-turbo, GPT-3.5-turbo | Yes |
|
|
37
|
+
| **Google Gemini** | Gemini 2.0 Flash, Gemini 1.5 Pro, Gemini 1.5 Flash | Yes |
|
|
38
|
+
| **Ollama** | Any locally installed model | No (local) |
|
|
13
39
|
|
|
14
|
-
##
|
|
40
|
+
## Available Plugins (MCP)
|
|
15
41
|
|
|
16
|
-
|
|
42
|
+
Edoardo supports the Model Context Protocol (MCP) for extending AI capabilities. Enable plugins from the settings panel.
|
|
17
43
|
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
44
|
+
| Plugin | Description | Auth Required |
|
|
45
|
+
|--------|-------------|---------------|
|
|
46
|
+
| **File System** | Read and write files on your local file system | Allowed paths configuration |
|
|
47
|
+
| **GitHub** | Access repositories, issues, pull requests, and code | Personal Access Token |
|
|
48
|
+
| **Notion** | Access Notion databases and pages | Integration Token + User ID |
|
|
49
|
+
| **Trello** | Manage boards, lists, and cards | API Key + Token + Workspace ID |
|
|
50
|
+
| **Fetch** | Fetch content from web URLs | None |
|
|
51
|
+
| **Web Scraping** | Advanced web content scraping | None |
|
|
52
|
+
| **Shopify** | Manage products, orders, customers, inventory | OAuth (Client ID + Secret) |
|
|
53
|
+
| **Vercel** | Manage projects, deployments, and domains | Personal Access Token |
|
|
54
|
+
| **Supabase** | Manage projects, databases, and APIs | Access Token |
|
|
55
|
+
| **MongoDB Atlas** | Manage Atlas clusters, users, and network access | Public/Private API Keys |
|
|
56
|
+
| **MongoDB Database** | Query and explore MongoDB databases | Connection String |
|
|
57
|
+
| **n8n** | Create and manage automation workflows | Host URL + API Key |
|
|
25
58
|
|
|
26
|
-
|
|
27
|
-
tseslint.configs.recommendedTypeChecked,
|
|
28
|
-
// Alternatively, use this for stricter rules
|
|
29
|
-
tseslint.configs.strictTypeChecked,
|
|
30
|
-
// Optionally, add this for stylistic rules
|
|
31
|
-
tseslint.configs.stylisticTypeChecked,
|
|
59
|
+
## Features
|
|
32
60
|
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
61
|
+
- **Multi-Provider Support**: Switch between AI providers without changing your workflow
|
|
62
|
+
- **MCP Plugin System**: Extend AI capabilities with powerful integrations
|
|
63
|
+
- **Local & Cloud**: Run locally or deploy to the cloud
|
|
64
|
+
- **Real-time Chat**: Streaming responses for a smooth experience
|
|
65
|
+
- **Tool Calling**: AI can use plugins to perform actions on your behalf
|
|
66
|
+
|
|
67
|
+
## Development
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
# Clone the repository
|
|
71
|
+
git clone https://github.com/user/edoardo.git
|
|
72
|
+
cd edoardo
|
|
73
|
+
|
|
74
|
+
# Install dependencies
|
|
75
|
+
npm install
|
|
76
|
+
|
|
77
|
+
# Start development server (with proxy)
|
|
78
|
+
npm start
|
|
79
|
+
|
|
80
|
+
# Build for production
|
|
81
|
+
npm run build
|
|
82
|
+
|
|
83
|
+
# Run standalone server
|
|
84
|
+
npm run standalone
|
|
44
85
|
```
|
|
45
86
|
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
87
|
+
## Plugin Configuration
|
|
88
|
+
|
|
89
|
+
### GitHub
|
|
90
|
+
1. Go to [GitHub Settings > Tokens](https://github.com/settings/tokens)
|
|
91
|
+
2. Create a Personal Access Token with required scopes
|
|
92
|
+
3. Enter the token in the GitHub plugin settings
|
|
93
|
+
|
|
94
|
+
### Notion
|
|
95
|
+
1. Go to [Notion Integrations](https://www.notion.so/my-integrations)
|
|
96
|
+
2. Create an internal integration
|
|
97
|
+
3. Copy the Integration Token and your User ID
|
|
98
|
+
4. Configure in the Notion plugin settings
|
|
99
|
+
|
|
100
|
+
### Trello
|
|
101
|
+
1. Go to [Trello App Key](https://trello.com/app-key)
|
|
102
|
+
2. Get your API Key and generate a Token
|
|
103
|
+
3. Find your Workspace ID
|
|
104
|
+
4. Configure in the Trello plugin settings
|
|
105
|
+
|
|
106
|
+
### Shopify
|
|
107
|
+
1. Go to your Shopify Admin > Apps > Develop apps
|
|
108
|
+
2. Create a custom app
|
|
109
|
+
3. Get Client ID and Client Secret
|
|
110
|
+
4. Enter your store URL (e.g., `your-store.myshopify.com`)
|
|
111
|
+
|
|
112
|
+
### n8n
|
|
113
|
+
1. Self-host n8n or use n8n cloud
|
|
114
|
+
2. Go to Settings > API > Create API Key
|
|
115
|
+
3. Enter your n8n host URL and API key
|
|
116
|
+
|
|
117
|
+
## Security
|
|
118
|
+
|
|
119
|
+
- API keys are stored locally in your browser's localStorage
|
|
120
|
+
- No credentials are sent to external servers (except to the respective API providers)
|
|
121
|
+
- For production deployments, consider using environment variables
|
|
122
|
+
|
|
123
|
+
## Troubleshooting
|
|
124
|
+
|
|
125
|
+
### Port already in use
|
|
126
|
+
```bash
|
|
127
|
+
edoardo --port=8080
|
|
73
128
|
```
|
|
129
|
+
|
|
130
|
+
### Plugins not loading
|
|
131
|
+
- Ensure you have the required dependencies (Node.js 18+)
|
|
132
|
+
- For stdio plugins, make sure `npx` or `uvx` is available
|
|
133
|
+
- Check the browser console for error messages
|
|
134
|
+
|
|
135
|
+
### MCP connection issues
|
|
136
|
+
- Verify your credentials are correct
|
|
137
|
+
- Check if the external service is accessible
|
|
138
|
+
- Review the plugin-specific documentation
|
|
139
|
+
|
|
140
|
+
## License
|
|
141
|
+
|
|
142
|
+
MIT
|
|
143
|
+
|
|
144
|
+
## Author
|
|
145
|
+
|
|
146
|
+
Daniele Carta
|
|
147
|
+
|
|
148
|
+
---
|
|
149
|
+
|
|
150
|
+
Made with AI Agents in mind.
|