Skip to content
This repository was archived by the owner on Feb 6, 2026. It is now read-only.

Improve Cosmos DB tool description for better LLM understanding #834

Closed
Copilot wants to merge 2 commits into from
Closed

Improve Cosmos DB tool description for better LLM understanding #834

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e4ad95a
Initial plan
Copilot Aug 4, 2025
656e333
Update Cosmos DB tool description for better LLM selection
Copilot Aug 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion areas/cosmos/src/AzureMcp.Cosmos/CosmosSetup.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ public void ConfigureServices(IServiceCollection services)
public void RegisterCommands(CommandGroup rootGroup, ILoggerFactory loggerFactory)
{
// Create Cosmos command group
var cosmos = new CommandGroup("cosmos", "Cosmos DB operations - Commands for managing and querying Azure Cosmos DB resources. Includes operations for databases, containers, and document queries.");
var cosmos = new CommandGroup("cosmos", "Cosmos DB operations - Commands for managing and querying Azure Cosmos DB databases, containers, and documents across different API models including SQL API and MongoDB API. Use this tool when you need to list Cosmos DB accounts, create or manage databases and containers, execute SQL queries against documents, or retrieve database/container metadata and configurations. This tool supports operations for NoSQL document databases and is ideal for document storage and retrieval scenarios. Do not use this tool for relational database operations, Azure SQL Database management, or complex transaction processing - this tool focuses on Cosmos DB's NoSQL document and key-value operations.");

Copilot AI Aug 4, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This extremely long string (over 600 characters) should be broken into multiple lines or extracted to a constant/method for better readability and maintainability. Consider using string interpolation, a multi-line string, or a separate method that builds the description.

Suggested change
var cosmos = new CommandGroup("cosmos", "Cosmos DB operations - Commands for managing and querying Azure Cosmos DB databases, containers, and documents across different API models including SQL API and MongoDB API. Use this tool when you need to list Cosmos DB accounts, create or manage databases and containers, execute SQL queries against documents, or retrieve database/container metadata and configurations. This tool supports operations for NoSQL document databases and is ideal for document storage and retrieval scenarios. Do not use this tool for relational database operations, Azure SQL Database management, or complex transaction processing - this tool focuses on Cosmos DB's NoSQL document and key-value operations.");
var cosmos = new CommandGroup("cosmos", CosmosCommandGroupDescription);

Copilot uses AI. Check for mistakes.

@joshfree joshfree Aug 5, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@xiangyan99 did you actually run the vector similarity tool to come up with this sentence or did you just take the default example from the issue Chris created?

@xiangyan99 xiangyan99 Aug 5, 2025 •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the default example?

Chris suggested the new description in #822.

rootGroup.AddSubGroup(cosmos);

// Create Cosmos subgroups
Expand Down
Loading