edoardo 1.0.0 → 1.0.2

package/README.md

@@ -1,73 +1,135 @@
-# React + TypeScript + Vite
+# Edoardo
 
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+AI Agent with MCP (Model Context Protocol) plugin support. Chat with multiple AI models and extend capabilities with powerful plugins.
 
-Currently, two official plugins are available:
+## Installation
 
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Babel](https://babeljs.io/) (or [oxc](https://oxc.rs) when used in [rolldown-vite](https://vite.dev/guide/rolldown)) for Fast Refresh
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+```bash
+npm install -g edoardo
+```
+
+## Quick Start
 
-## React Compiler
+```bash
+# Start the application (opens browser automatically)
+edoardo
 
-The React Compiler is not enabled on this template because of its impact on dev & build performances. To add it, see [this documentation](https://react.dev/learn/react-compiler/installation).
+# Start on a specific port
+edoardo --port=8080
 
-## Expanding the ESLint configuration
+# Start without opening browser
+edoardo --no-open
+```
 
-If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
+## CLI Options
 
-```js
-export default defineConfig([
-  globalIgnores(['dist']),
-  {
-    files: ['**/*.{ts,tsx}'],
-    extends: [
-      // Other configs...
+| Option | Description |
+|--------|-------------|
+| `--port=<number>` | Set the server port (default: 3001) |
+| `--no-open` | Don't open browser automatically |
+| `--help`, `-h` | Show help message |
 
-      // Remove tseslint.configs.recommended and replace with this
-      tseslint.configs.recommendedTypeChecked,
-      // Alternatively, use this for stricter rules
-      tseslint.configs.strictTypeChecked,
-      // Optionally, add this for stylistic rules
-      tseslint.configs.stylisticTypeChecked,
+## Supported LLM Providers
 
-      // Other configs...
-    ],
-    languageOptions: {
-      parserOptions: {
-        project: ['./tsconfig.node.json', './tsconfig.app.json'],
-        tsconfigRootDir: import.meta.dirname,
-      },
-      // other options...
-    },
-  },
-])
-```
+| Provider | Models | API Key Required |
+|----------|--------|------------------|
+| **OpenAI** | GPT-4o, GPT-4o-mini, GPT-4-turbo, GPT-3.5-turbo | Yes |
+| **Google Gemini** | Gemini 2.0 Flash, Gemini 1.5 Pro, Gemini 1.5 Flash | Yes |
+| **Grok (xAI)** | Grok 3, Grok 3 Mini, Grok 4 Fast, Grok Code, Grok Imagine | Yes |
+| **Ollama** | Any locally installed model | No (local) |
+
+## Available Plugins (MCP)
+
+Edoardo supports the Model Context Protocol (MCP) for extending AI capabilities. Enable plugins from the settings panel.
+
+| Plugin | Description | Auth Required |
+|--------|-------------|---------------|
+| **File System** | Read and write files on your local file system | Allowed paths configuration |
+| **GitHub** | Access repositories, issues, pull requests, and code | Personal Access Token |
+| **Notion** | Access Notion databases and pages | Integration Token + User ID |
+| **Trello** | Manage boards, lists, and cards | API Key + Token + Workspace ID |
+| **Fetch** | Fetch content from web URLs | None |
+| **Web Scraping** | Advanced web content scraping | None |
+| **Shopify** | Manage products, orders, customers, inventory | OAuth (Client ID + Secret) |
+| **Vercel** | Manage projects, deployments, and domains | Personal Access Token |
+| **Supabase** | Manage projects, databases, and APIs | Access Token |
+| **MongoDB Atlas** | Manage Atlas clusters, users, and network access | Public/Private API Keys |
+| **MongoDB Database** | Query and explore MongoDB databases | Connection String |
+| **n8n** | Create and manage automation workflows | Host URL + API Key |
+
+## Features
+
+- **Multi-Provider Support**: Switch between AI providers without changing your workflow
+- **MCP Plugin System**: Extend AI capabilities with powerful integrations
+- **Local & Cloud**: Run locally or deploy to the cloud
+- **Real-time Chat**: Streaming responses for a smooth experience
+- **Tool Calling**: AI can use plugins to perform actions on your behalf
+
+## Collaboration
+
+Want to contribute or have questions? Contact me at **crtdaniele@gmail.com**
+
+## Plugin Configuration
+
+### GitHub
+1. Go to [GitHub Settings > Tokens](https://github.com/settings/tokens)
+2. Create a Personal Access Token with required scopes
+3. Enter the token in the GitHub plugin settings
+
+### Notion
+1. Go to [Notion Integrations](https://www.notion.so/my-integrations)
+2. Create an internal integration
+3. Copy the Integration Token and your User ID
+4. Configure in the Notion plugin settings
 
-You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:
-
-```js
-// eslint.config.js
-import reactX from 'eslint-plugin-react-x'
-import reactDom from 'eslint-plugin-react-dom'
-
-export default defineConfig([
-  globalIgnores(['dist']),
-  {
-    files: ['**/*.{ts,tsx}'],
-    extends: [
-      // Other configs...
-      // Enable lint rules for React
-      reactX.configs['recommended-typescript'],
-      // Enable lint rules for React DOM
-      reactDom.configs.recommended,
-    ],
-    languageOptions: {
-      parserOptions: {
-        project: ['./tsconfig.node.json', './tsconfig.app.json'],
-        tsconfigRootDir: import.meta.dirname,
-      },
-      // other options...
-    },
-  },
-])
+### Trello
+1. Go to [Trello App Key](https://trello.com/app-key)
+2. Get your API Key and generate a Token
+3. Find your Workspace ID
+4. Configure in the Trello plugin settings
+
+### Shopify
+1. Go to your Shopify Admin > Apps > Develop apps
+2. Create a custom app
+3. Get Client ID and Client Secret
+4. Enter your store URL (e.g., `your-store.myshopify.com`)
+
+### n8n
+1. Self-host n8n or use n8n cloud
+2. Go to Settings > API > Create API Key
+3. Enter your n8n host URL and API key
+
+## Security
+
+- API keys are stored locally in your browser's localStorage
+- No credentials are sent to external servers (except to the respective API providers)
+- For production deployments, consider using environment variables
+
+## Troubleshooting
+
+### Port already in use
+```bash
+edoardo --port=8080
 ```
+
+### Plugins not loading
+- Ensure you have the required dependencies (Node.js 18+)
+- For stdio plugins, make sure `npx` or `uvx` is available
+- Check the browser console for error messages
+
+### MCP connection issues
+- Verify your credentials are correct
+- Check if the external service is accessible
+- Review the plugin-specific documentation
+
+## License
+
+MIT
+
+## Author
+
+Daniele Carta
+
+---
+
+Made with AI Agents in mind.