Skip to content

Commit 37bfc3a

Browse files
committed
elaborate on Readme
1 parent af42edb commit 37bfc3a

File tree

1 file changed

+27
-1
lines changed

1 file changed

+27
-1
lines changed

README.md

+27-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,27 @@
1-
TODO: read https://github.com/nvim-neorocks/nvim-best-practices
1+
magenta.nvim is a plugin for agent-assisted LLM development in neovim.
2+
3+
Rather than writing complex code to automatically provide context to the LLM, magenta is built around the idea that you
4+
can just expose tools to the LLM and have it decide what it needs to do.
5+
6+
The initial offering will start with basic tools:
7+
8+
- get_file
9+
- list_directory
10+
- edit file
11+
- run terminal command
12+
13+
Eventually I'd like to add more advanced tools:
14+
15+
- list symbols for file
16+
- list diagnostics
17+
- get definition or "summary" info for a symbol
18+
- find symbol references
19+
20+
The general idea is that some of these will be automated and not require user intervention, while others will require
21+
user approval. (for example, getting the type definition of a symbol may be automated, while reading a dotfile will require
22+
user permission).
23+
24+
I'm also hoping to eventually implement an inline diff / edit confirmation system like windsurf or avante.
25+
26+
This project is still in its early days and this is my first neovim plugin so it will probably be a while until it's useful to anyone. But I am investing some time in building a robust framework and testing system so that
27+
it is easier to contribute to in the future. If you'd like to help, please reach out. You can find my contact info at my blog - dlants.me

0 commit comments

Comments
 (0)