From f3583a04cad35151be6679d066c9a3f0eb8d27bd Mon Sep 17 00:00:00 2001 From: yetone Date: Thu, 13 Mar 2025 00:01:19 +0800 Subject: [PATCH] docs: add mcp doc (#1572) --- README.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index adb33dc..c783cef 100644 --- a/README.md +++ b/README.md @@ -291,7 +291,8 @@ require('avante').setup ({ ### Default setup configuration -_See [config.lua#L9](./lua/avante/config.lua) for the full config_ +
+_See [config.lua#L9](./lua/avante/config.lua) for the full config_ ```lua { @@ -422,6 +423,7 @@ _See [config.lua#L9](./lua/avante/config.lua) for the full config_ }, } ``` +
## Blink.cmp users @@ -624,7 +626,8 @@ The following key bindings are available for use with `avante.nvim`: ### Neotree shortcut -In the neotree sidebar, you can also add a new keyboard shortcut to quickly add `file/folder` to `Avante Selected Files`. +
+In the neotree sidebar, you can also add a new keyboard shortcut to quickly add `file/folder` to `Avante Selected Files`. ```lua return { @@ -667,6 +670,7 @@ return { }, } ``` +
## Commands @@ -826,7 +830,8 @@ Avante allows you to define custom tools that can be used by the AI during code ### Example: Go Test Runner -Here's an example of a custom tool that runs Go unit tests: +
+Here's an example of a custom tool that runs Go unit tests: ```lua { @@ -867,6 +872,11 @@ Here's an example of a custom tool that runs Go unit tests: }, } ``` +
+ +## MCP + +Now you can integrate MCP functionality for Avante through `mcphub.nvim`. For detailed documentation, please refer to [mcphub.nvim](https://github.com/ravitemer/mcphub.nvim#avante-integration) ## Custom prompts @@ -935,7 +945,7 @@ If you have the following structure: - [x] Chat with project (You can use `@codebase` to chat with the whole project) - [x] Chat with selected files - [x] Tool use -- [ ] MCP +- [x] MCP ## Roadmap