Skip to content

Commit beb8d72

Browse files
alenakhineikaAnemy
andauthored
docs: update README with information about the participant VSCODE-587 (#841)
* docs: update README with information about the participant VSCODE-587 * refactor: wrap participant id * refactor: remove empty line * Update README.md Co-authored-by: Rhys <[email protected]> * Update README.md Co-authored-by: Rhys <[email protected]> * Update README.md Co-authored-by: Rhys <[email protected]> * Update README.md Co-authored-by: Rhys <[email protected]> * docs: update screenshot --------- Co-authored-by: Rhys <[email protected]>
1 parent 36a6784 commit beb8d72

File tree

3 files changed

+21
-0
lines changed

3 files changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,25 @@ Connect to Atlas Stream Processing instances and develop stream processors using
7777

7878
![Atlas Stream Processing Playground](resources/screenshots/atlas-stream-processing.png)
7979

80+
### MongoDB Copilot Participant
81+
82+
Use natural language to interact with your clusters and generate MongoDB-related code with GitHub Copilot Chat in VS Code.
83+
84+
_Note: To use the MongoDB Participant, you must have the [GitHub Copilot](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot) extension. By using Copilot Chat you agree to [GitHub Copilot chat preview terms](https://docs.github.com/en/copilot/responsible-use-of-github-copilot-features/responsible-use-of-github-copilot-chat-in-your-ide). Find more details about the MongoDB GenAI Features in the [FAQ](https://www.mongodb.com/docs/generative-ai-faq/)._
85+
86+
#### How to use the MongoDB Participant
87+
88+
1. Enter `@MongoDB` in the chat input field to start a conversation with the MongoDB Participant.
89+
90+
![MongoDB Participant](resources/screenshots/mongodb-participant.png)
91+
92+
2. Start typing `/` in the chat window to get the list of available chat participant commands.
93+
94+
![MongoDB Participant Commands](resources/screenshots/mongodb-participant-commands.png)
95+
96+
- `/docs` is a participant command that finds answers to coding-related questions in the [MongoDB documentation](https://www.mongodb.com/docs/).
97+
- `/query` is a participant command that generates MongoDB queries from natural language to be used with a connected MongoDB cluster. It generates both queries and aggregations depending on the complexity of the request. It utilizes schema to reduce model hallucinations. It provides a code action to open generated code in a playground and an action to directly run the code from the Copilot chat interface.
98+
- `/schema` is a participant command that analyzes and returns information about a collection's schema.
8099

81100
## Extension Settings
82101

@@ -99,6 +118,8 @@ Connect to Atlas Stream Processing instances and develop stream processors using
99118
| `mdb.useDefaultTemplateForPlayground` | Choose whether to use the default template for playground files or to start with an empty playground editor. | `true` |
100119
| `mdb.uniqueObjectIdPerCursor` | The default behavior is to generate a single ObjectId and insert it on all cursors. Set to true to generate a unique ObjectId per cursor instead. | `false` |
101120
| `mdb.sendTelemetry` | Opt-in and opt-out for diagnostic and telemetry collection. | `true` |
121+
| `mdb.confirmRunCopilotCode` | Show a confirmation message before running code generated by the MongoDB participant. | `true` |
122+
| `mdb.useSampleDocsInCopilot` | Enable sending sample field values with the VSCode copilot chat @MongoDB participant /query command. | `false` |
102123

103124
## Additional Settings
104125

57.2 KB
Loading
55.8 KB
Loading

0 commit comments

Comments
 (0)