diff --git a/README.md b/README.md index d3233d25f..ecad90e60 100644 --- a/README.md +++ b/README.md @@ -77,6 +77,25 @@ Connect to Atlas Stream Processing instances and develop stream processors using ![Atlas Stream Processing Playground](resources/screenshots/atlas-stream-processing.png) +### MongoDB Copilot Participant + +Use natural language to interact with your clusters and generate MongoDB-related code with GitHub Copilot Chat in VS Code. + +_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/)._ + +#### How to use the MongoDB Participant + +1. Enter `@MongoDB` in the chat input field to start a conversation with the MongoDB Participant. + +![MongoDB Participant](resources/screenshots/mongodb-participant.png) + +2. Start typing `/` in the chat window to get the list of available chat participant commands. + +![MongoDB Participant Commands](resources/screenshots/mongodb-participant-commands.png) + +- `/docs` is a participant command that finds answers to coding-related questions in the [MongoDB documentation](https://www.mongodb.com/docs/). +- `/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. +- `/schema` is a participant command that analyzes and returns information about a collection's schema. ## Extension Settings @@ -99,6 +118,8 @@ Connect to Atlas Stream Processing instances and develop stream processors using | `mdb.useDefaultTemplateForPlayground` | Choose whether to use the default template for playground files or to start with an empty playground editor. | `true` | | `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` | | `mdb.sendTelemetry` | Opt-in and opt-out for diagnostic and telemetry collection. | `true` | +| `mdb.confirmRunCopilotCode` | Show a confirmation message before running code generated by the MongoDB participant. | `true` | +| `mdb.useSampleDocsInCopilot` | Enable sending sample field values with the VSCode copilot chat @MongoDB participant /query command. | `false` | ## Additional Settings diff --git a/resources/screenshots/mongodb-participant-commands.png b/resources/screenshots/mongodb-participant-commands.png new file mode 100644 index 000000000..ab5e9319a Binary files /dev/null and b/resources/screenshots/mongodb-participant-commands.png differ diff --git a/resources/screenshots/mongodb-participant.png b/resources/screenshots/mongodb-participant.png new file mode 100644 index 000000000..69f3d6e2f Binary files /dev/null and b/resources/screenshots/mongodb-participant.png differ