Skip to content

Commit fb4cd25

Browse files
committed
docs: update README
1 parent ed5f22d commit fb4cd25

File tree

1 file changed

+29
-42
lines changed

1 file changed

+29
-42
lines changed

README.md

Lines changed: 29 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,9 @@ uv run main.py
5454
```
5555

5656

57-
## Connecting to the MCP Server using SSE
57+
## Connecting to the MCP Server using Streamable HTTP
5858

59-
All the most popular MCP clients (Claude Desktop, Cursor & Windsurf) use the following config format:
59+
Example config:
6060

6161
```
6262
{
@@ -68,48 +68,35 @@ All the most popular MCP clients (Claude Desktop, Cursor & Windsurf) use the fol
6868
}
6969
```
7070

71-
VS Code
72-
73-
```
74-
"mcp": {
75-
"servers": {
76-
"eagle-mcp-server": {
77-
"type": "sse",
78-
"url": "http://localhost:8000/mcp"
79-
}
80-
}
81-
}
82-
```
83-
8471
## Tools
8572

86-
| Supported | Operation ID | API endpoint | Enabled (default) | Category |
87-
|:----:|:-------------------------|:---------------------------|:----:|:------------|
88-
|| `connect` | /api/connect | | MCP |
89-
|| `get_application_info` | /api/application/info | ⚫︎ | Application |
90-
|| `create_folder` | /api/folder/create | ⚫︎ | Folder |
91-
|| `rename_folder` | /api/folder/rename | | Folder |
92-
|| `update_folder` | /api/folder/update | ⚫︎ | Folder |
93-
|| `get_folder_list` | /api/folder/list | ⚫︎ | Folder |
94-
|| `get_folder_list_recent` | /api/folder/listRecent | | Folder |
95-
|| `add_item_from_url` | /api/item/addFromURL | | Item |
96-
|| `add_items_from_urls` | /api/item/addFromURLs | | Item |
97-
|| `add_item_from_path` | /api/item/addFromPath | ⚫︎ | Item |
98-
|| `add_items_from_paths` | /api/item/addFromPaths | | Item |
99-
|| `add_bookmark` | /api/item/addBookmark | | Item |
100-
|| `get_item_info` | /api/item/info | ⚫︎ | Item |
101-
|| `get_item_source` | /api/item/source | ⚫︎ | Item |
102-
|| `get_item_thumbnail` | /api/item/thumbnail | | Item |
103-
|| `get_item_list` | /api/item/list | ⚫︎ | Item |
104-
|| `move_item_to_trash` | /api/item/moveToTrash | ⚫︎ | Item |
105-
|| `refresh_item_palette` | /api/item/refreshPalette | | Item |
106-
|| `refresh_item_thumbnail` | /api/item/refreshThumbnail | | Item |
107-
|| `update_item` | /api/item/update | ⚫︎ | Item |
108-
|| `get_library_info` | /api/library/info | ⚫︎ | Library |
109-
|| `get_library_history` | /api/library/history | | Library |
110-
|| `switch_library` | /api/library/switch | | Library |
111-
|| `get_library_icon` | /api/library/icon | | Library |
112-
| [ ] | ... | ... | | ... |
73+
| Supported | Eagle API endpoint | Operation ID | Enabled (default) | Category |
74+
|:----:|:---------------------------|:-------------------------|:----:|:------------|
75+
|| - | `connect` | | MCP |
76+
|| /api/application/info | `get_application_info` | ⚫︎ | Application |
77+
|| /api/folder/create | `create_folder` | ⚫︎ | Folder |
78+
|| /api/folder/rename | `rename_folder` | | Folder |
79+
|| /api/folder/update | `update_folder` | ⚫︎ | Folder |
80+
|| /api/folder/list | `get_folder_list` | ⚫︎ | Folder |
81+
|| /api/folder/listRecent | `get_folder_list_recent` | | Folder |
82+
|| /api/item/addFromURL | `add_item_from_url` | | Item |
83+
|| /api/item/addFromURLs | `add_items_from_urls` | | Item |
84+
|| /api/item/addFromPath | `add_item_from_path` | ⚫︎ | Item |
85+
|| /api/item/addFromPaths | `add_items_from_paths` | | Item |
86+
|| /api/item/addBookmark | `add_bookmark` | | Item |
87+
|| /api/item/info | `get_item_info` | ⚫︎ | Item |
88+
|| - | `get_item_source` | ⚫︎ | Item |
89+
|| /api/item/thumbnail | `get_item_thumbnail` | | Item |
90+
|| /api/item/list | `get_item_list` | ⚫︎ | Item |
91+
|| /api/item/moveToTrash | `move_item_to_trash` | ⚫︎ | Item |
92+
|| /api/item/refreshPalette | `refresh_item_palette` | | Item |
93+
|| /api/item/refreshThumbnail | `refresh_item_thumbnail` | | Item |
94+
|| /api/item/update | `update_item` | ⚫︎ | Item |
95+
|| /api/library/info | `get_library_info` | ⚫︎ | Library |
96+
|| /api/library/history | `get_library_history` | | Library |
97+
|| /api/library/switch | `switch_library` | | Library |
98+
|| /api/library/icon | `get_library_icon` | | Library |
99+
|
113100

114101
MCP Server API docs:
115102
- https://tuki0918.github.io/eagle-mcp-server/

0 commit comments

Comments
 (0)