-
Notifications
You must be signed in to change notification settings - Fork 436
[Onboard][Part One] Mcp Server for Azure DocumentDB (Index) #1968
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
xingfan-git
wants to merge
21
commits into
main
Choose a base branch
from
users/xingfan/onboardingvcoremcp_connection
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 2 commits
Commits
Show all changes
21 commits
Select commit
Hold shift + click to select a range
1edc300
Add DocumentDB connection MCP tools
xingfan-git 1f5ff7e
update pr number
xingfan-git 2442f7d
try fix build pipeline
xingfan-git ba35d97
livetest files & resolve comments
xingfan-git 08efc55
sync azmcp-commands.md
xingfan-git 2c11d8c
dotnet format
xingfan-git 383acaf
fix run recorded tests
xingfan-git 9599980
resolve comments
xingfan-git bb42d4a
update azmcp-commands.md & dotnet format fix
xingfan-git 2fe4f1c
fix build pipeline
xingfan-git 6088353
merge main & resolve conflicts
xingfan-git c6fe9f7
resolve comments
xingfan-git 225d9a3
update description in consolidated_tools
xingfan-git b084426
revert the metadata change and mark connection toggle tool as non-ope…
xingfan-git 6bd0d18
remove connection tools and implement index tools
xingfan-git 08d80c5
dotnet format
xingfan-git 9e0b67d
sync metadata
xingfan-git ccea698
update destructive for create index
xingfan-git cdbc996
fix livetest
xingfan-git 5ac4fc9
update live test
xingfan-git 14dec4c
update yaml file
xingfan-git File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
3 changes: 3 additions & 0 deletions
3
servers/Azure.Mcp.Server/changelog-entries/1773035723557.yaml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| changes: | ||
| - section: "Features Added" | ||
| description: "Added DocumentDB tools for managing Azure DocumentDB (with MongoDB compatibility) connection" |
3 changes: 3 additions & 0 deletions
3
servers/Azure.Mcp.Server/changelog-entries/1773043407868.yaml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| changes: | ||
| - section: "Features Added" | ||
| description: "MCP tools for managing Azure DocumentDB (with MongoDB compatibility) connection" | ||
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -146,6 +146,72 @@ | |
| "cosmos_database_container_item_query" | ||
| ] | ||
| }, | ||
| { | ||
| "name": "get_azure_database_connection_status", | ||
| "description": "Check whether there is an active Azure DocumentDB session and return the current connection state plus masked connection details for Azure Cosmos DB for MongoDB (vCore).", | ||
| "toolMetadata": { | ||
| "destructive": { | ||
| "value": false, | ||
| "description": "This tool performs only additive updates without deleting or modifying existing resources." | ||
| }, | ||
| "idempotent": { | ||
| "value": false, | ||
| "description": "Running this operation multiple times with the same arguments may have additional effects or produce different results." | ||
| }, | ||
| "openWorld": { | ||
| "value": true, | ||
| "description": "This tool may interact with an unpredictable or dynamic set of entities (like web search)." | ||
| }, | ||
| "readOnly": { | ||
| "value": true, | ||
| "description": "This tool only performs read operations without modifying any state or data." | ||
| }, | ||
| "secret": { | ||
| "value": false, | ||
| "description": "This tool does not handle sensitive or secret information." | ||
| }, | ||
| "localRequired": { | ||
| "value": false, | ||
| "description": "This tool is available in both local and remote server modes." | ||
| } | ||
| }, | ||
| "mappedToolList": [ | ||
| "documentdb_connection_get_connection_status" | ||
| ] | ||
| }, | ||
| { | ||
| "name": "manage_azure_documentdb_connections", | ||
| "description": "Open, connect, switch, close, or disconnect Azure DocumentDB sessions. Use a connection string to start or change the active Azure Cosmos DB for MongoDB (vCore) session before subsequent DocumentDB operations.", | ||
| "toolMetadata": { | ||
| "destructive": { | ||
| "value": false, | ||
| "description": "This tool performs only additive updates without deleting or modifying existing resources." | ||
| }, | ||
| "idempotent": { | ||
| "value": false, | ||
| "description": "Running this operation multiple times with the same arguments may have additional effects or produce different results." | ||
| }, | ||
| "openWorld": { | ||
| "value": true, | ||
| "description": "This tool may interact with an unpredictable or dynamic set of entities (like web search)." | ||
| }, | ||
| "readOnly": { | ||
| "value": false, | ||
| "description": "This tool may modify its environment and perform write operations (create, update, delete)." | ||
| }, | ||
| "secret": { | ||
| "value": false, | ||
| "description": "This tool does not handle sensitive or secret information." | ||
| }, | ||
|
Comment on lines
+239
to
+242
|
||
| "localRequired": { | ||
| "value": false, | ||
| "description": "This tool is available in both local and remote server modes." | ||
| } | ||
| }, | ||
| "mappedToolList": [ | ||
| "documentdb_connection_toggle" | ||
| ] | ||
| }, | ||
| { | ||
| "name": "create_azure_sql_databases_and_servers", | ||
| "description": "Create new Azure SQL databases and SQL servers with configurable performance tiers and settings.", | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| // Copyright (c) Microsoft Corporation. | ||
| // Licensed under the MIT License. | ||
|
|
||
| using System.Runtime.CompilerServices; | ||
|
|
||
| [assembly: InternalsVisibleTo("Azure.Mcp.Tools.DocumentDb.UnitTests")] |
22 changes: 22 additions & 0 deletions
22
tools/Azure.Mcp.Tools.DocumentDb/src/Azure.Mcp.Tools.DocumentDb.csproj
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk"> | ||
| <PropertyGroup> | ||
| <IsAotCompatible>true</IsAotCompatible> | ||
| <!-- Disable trim analyzer warnings for MongoDB.Driver which uses extensive reflection --> | ||
| <EnableTrimAnalyzer>false</EnableTrimAnalyzer> | ||
| </PropertyGroup> | ||
| <ItemGroup> | ||
| <EmbeddedResource Include="**\Resources\*.txt" /> | ||
| <EmbeddedResource Include="**\Resources\*.json" /> | ||
| </ItemGroup> | ||
| <ItemGroup> | ||
| <ProjectReference Include="..\..\..\core\Azure.Mcp.Core\src\Azure.Mcp.Core.csproj" /> | ||
| </ItemGroup> | ||
| <ItemGroup> | ||
| <PackageReference Include="Azure.ResourceManager" /> | ||
| <PackageReference Include="MongoDB.Driver" /> | ||
|
|
||
| <PackageReference Include="Microsoft.Extensions.DependencyInjection" /> | ||
| <PackageReference Include="ModelContextProtocol" /> | ||
| <PackageReference Include="System.CommandLine" /> | ||
| </ItemGroup> | ||
| </Project> |
14 changes: 14 additions & 0 deletions
14
tools/Azure.Mcp.Tools.DocumentDb/src/Commands/BaseDocumentDbCommand.cs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| // Copyright (c) Microsoft Corporation. | ||
| // Licensed under the MIT License. | ||
|
|
||
| using System.Diagnostics.CodeAnalysis; | ||
| using Azure.Mcp.Core.Commands; | ||
| using Azure.Mcp.Tools.DocumentDb.Options; | ||
|
|
||
| namespace Azure.Mcp.Tools.DocumentDb.Commands; | ||
|
|
||
| public abstract class BaseDocumentDbCommand< | ||
| [DynamicallyAccessedMembers(TrimAnnotations.CommandAnnotations)] TOptions> | ||
| : GlobalCommand<TOptions> where TOptions : BaseDocumentDbOptions, new() | ||
| { | ||
| } |
100 changes: 100 additions & 0 deletions
100
tools/Azure.Mcp.Tools.DocumentDb/src/Commands/Connection/ConnectionToggleCommand.cs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,100 @@ | ||
| // Copyright (c) Microsoft Corporation. | ||
| // Licensed under the MIT License. | ||
|
|
||
| using System.CommandLine; | ||
| using Azure.Mcp.Core.Commands; | ||
| using Azure.Mcp.Core.Extensions; | ||
| using Azure.Mcp.Tools.DocumentDb.Options; | ||
| using Azure.Mcp.Tools.DocumentDb.Services; | ||
| using Microsoft.Extensions.Logging; | ||
| using Microsoft.Mcp.Core.Commands; | ||
| using Microsoft.Mcp.Core.Extensions; | ||
| using Microsoft.Mcp.Core.Models.Command; | ||
|
|
||
| namespace Azure.Mcp.Tools.DocumentDb.Commands.Connection; | ||
|
|
||
| public sealed class ConnectionToggleCommand(ILogger<ConnectionToggleCommand> logger) | ||
| : BaseDocumentDbCommand<ConnectionToggleOptions>() | ||
| { | ||
| private const string ConnectAction = "connect"; | ||
| private const string DisconnectAction = "disconnect"; | ||
|
|
||
| private readonly ILogger<ConnectionToggleCommand> _logger = logger; | ||
|
|
||
| public override string Id => "a1b2c3d4-e5f6-4a1b-8c9d-0e1f2a3b4c5d"; | ||
|
|
||
| public override string Name => "toggle"; | ||
|
|
||
| public override string Description => "Open, connect, switch, close, or disconnect the active Azure DocumentDB session for Azure Cosmos DB for MongoDB (vCore). Use this when the user wants to connect with a connection string, reconnect to a different cluster, or end the current DocumentDB session before running database commands."; | ||
xingfan-git marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| public override string Title => "Connect or disconnect DocumentDB"; | ||
|
|
||
| public override ToolMetadata Metadata => new() | ||
| { | ||
| Destructive = false, | ||
| ReadOnly = false | ||
| }; | ||
xingfan-git marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| protected override void RegisterOptions(Command command) | ||
| { | ||
| base.RegisterOptions(command); | ||
| command.Options.Add(DocumentDbOptionDefinitions.Action); | ||
| command.Options.Add(DocumentDbOptionDefinitions.ConnectionString); | ||
| command.Options.Add(DocumentDbOptionDefinitions.TestConnection); | ||
| command.Validators.Add(commandResult => | ||
| { | ||
| var action = commandResult.GetValueOrDefault(DocumentDbOptionDefinitions.Action); | ||
| var connectionString = commandResult.GetValueOrDefault(DocumentDbOptionDefinitions.ConnectionString); | ||
xingfan-git marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| if (string.Equals(action, ConnectAction, StringComparison.OrdinalIgnoreCase) | ||
| && string.IsNullOrWhiteSpace(connectionString)) | ||
| { | ||
| commandResult.AddError($"Missing Required option: {DocumentDbOptionDefinitions.ConnectionString.Name}"); | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| protected override ConnectionToggleOptions BindOptions(ParseResult parseResult) | ||
| { | ||
| var options = base.BindOptions(parseResult); | ||
| options.Action = parseResult.GetValueOrDefault<string>(DocumentDbOptionDefinitions.Action.Name); | ||
| options.ConnectionString = parseResult.GetValueOrDefault<string>(DocumentDbOptionDefinitions.ConnectionString.Name); | ||
| options.TestConnection = parseResult.GetValueOrDefault<bool>(DocumentDbOptionDefinitions.TestConnection.Name); | ||
| return options; | ||
| } | ||
|
|
||
| public override async Task<CommandResponse> ExecuteAsync( | ||
| CommandContext context, | ||
| ParseResult parseResult, | ||
| CancellationToken cancellationToken) | ||
| { | ||
| var options = BindOptions(parseResult); | ||
|
|
||
| try | ||
| { | ||
| if (!Validate(parseResult.CommandResult, context.Response).IsValid) | ||
| { | ||
| return context.Response; | ||
| } | ||
xingfan-git marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| var service = context.GetService<IDocumentDbService>(); | ||
|
|
||
| var result = options.Action switch | ||
| { | ||
| ConnectAction => await service.ConnectAsync(options.ConnectionString!, options.TestConnection, cancellationToken), | ||
| DisconnectAction => await service.DisconnectAsync(cancellationToken), | ||
| _ => throw new InvalidOperationException($"Unsupported connection action '{options.Action}'.") | ||
xingfan-git marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| }; | ||
|
|
||
| DocumentDbResponseHelper.ProcessResponse(context, result); | ||
|
|
||
| return context.Response; | ||
| } | ||
| catch (Exception ex) | ||
| { | ||
| _logger.LogError(ex, "Failed to execute DocumentDB connection action {Action}", options.Action); | ||
| HandleException(context, ex); | ||
| return context.Response; | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@hallipr could you review this change, as I don't know the trimmed build usage well enough and this PR is added a dependency which doesn't support trimming.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why don't we see a CI failure for this ?
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think because they're disabling trimming in New-BuildInfo. We just stop trimming the server instead of failing to trim it