Skip to content

tool-reference.md

Latest commit

 

History

History
267 lines (197 loc) · 7.35 KB

tool-reference.md

File metadata and controls

267 lines (197 loc) · 7.35 KB

NetContextServer Tool Reference

This document provides detailed documentation for all available tools in NetContextServer. Each tool is documented with its description, parameters, and usage examples.

File Operations

list_files

Lists all .NET source files in the specified project directory.

Parameters:

  • --project-path (required): Absolute path to the project directory containing the .cs files

Example:

dotnet run --project src/NetContextClient/NetContextClient.csproj -- list-files --project-path "D:\Projects\MyApp\src\MyProject"

list_projects

Scans the current solution and returns all .csproj files found.

Parameters: None

Example:

dotnet run --project src/NetContextClient/NetContextClient.csproj -- list-projects

list_projects_in_dir

Searches a specific directory for .csproj files.

Parameters:

  • --directory (required): Absolute path to the directory to search for .csproj files

Example:

dotnet run --project src/NetContextClient/NetContextClient.csproj -- list-projects-in-dir --directory "D:\Projects\MyApp\src"

list_solutions

Returns all .sln files found in the base directory.

Parameters: None

Example:

dotnet run --project src/NetContextClient/NetContextClient.csproj -- list-solutions

list_source_files

Lists all source files in a project directory.

Parameters:

  • --project-dir (required): Absolute path to the project directory to scan for source files

Example:

dotnet run --project src/NetContextClient/NetContextClient.csproj -- list-source-files --project-dir "D:\Projects\MyApp\src\MyProject"

open_file

Reads and returns the contents of a specified file.

Parameters:

  • --file-path (required): Absolute path to the file to read

Example:

dotnet run --project src/NetContextClient/NetContextClient.csproj -- open-file --file-path "D:\Projects\MyApp\src\MyProject\Program.cs"

set_base_directory

Sets the base directory for all file operations.

Parameters:

  • --directory (required): Absolute path to set as the new base directory. Must be a valid, existing directory

Example:

dotnet run --project src/NetContextClient/NetContextClient.csproj -- set-base-dir --directory "D:\Projects\MyApp"

get_base_directory

Returns the current base directory used for all file operations.

Parameters: None

Example:

dotnet run --project src/NetContextClient/NetContextClient.csproj -- get-base-dir

Search Operations

search_code

Performs a text-based search across all code files for the specified text.

Parameters:

  • --text (required): The exact text string to search for in the codebase

Example:

dotnet run --project src/NetContextClient/NetContextClient.csproj -- search-code --text "public class Program"

semantic_search

Performs a semantic similarity search across the codebase using AI.

Parameters:

  • --query (required): Natural language description of the code you're looking for
  • --top (optional): Number of results to return (default: 5)

Example:

# With default number of results
dotnet run --project src/NetContextClient/NetContextClient.csproj -- semantic-search --query "file handling operations"

# With custom number of results
dotnet run --project src/NetContextClient/NetContextClient.csproj -- semantic-search --query "error handling" --top 10

Note: Requires Azure OpenAI credentials to be set in environment variables:

  • AZURE_OPENAI_ENDPOINT
  • AZURE_OPENAI_API_KEY

Package Analysis

analyze_packages

Analyzes NuGet packages in all projects found in the base directory.

Parameters: None

Example:

dotnet run --project src/NetContextClient/NetContextClient.csproj -- analyze-packages

Output includes:

  • Package versions and available updates
  • Usage analysis and detection of unused packages
  • Security vulnerability warnings
  • Recommendations for updates or removal
  • Deep transitive dependency analysis
  • Visual dependency graph representation with smart grouping

Dependency Graph Features:

  • Hierarchical tree visualization in ASCII-art format
  • Automatic grouping of related dependencies by namespace
  • Color-coding of dependencies in the console:
    • Cyan: Leaf dependencies (end nodes)
    • Green: Intermediate dependencies
    • Yellow: Grouped namespaces
  • Clear visual separation between dependency groups
  • Configurable depth of transitive dependency resolution

Example Output:

Project: MyProject.csproj
  Found 3 package(s):
  - ✅ Newtonsoft.Json (13.0.1)
    Used in 5 location(s)

    Dependencies:
    └─ Newtonsoft.Json
       ├─ Microsoft.*
       │  └─ Microsoft.CSharp
       └─ System.*
          └─ System.ComponentModel

  - 🔄 Microsoft.Extensions.DependencyInjection (5.0.2 → 6.0.1)
    Update available: 6.0.1
    Used in 3 location(s)

    Dependencies:
    └─ Microsoft.Extensions.DependencyInjection
       └─ Microsoft.*
          └─ Microsoft.Extensions.DependencyInjection.Abstractions

  - ⚠️ Unused.Package (1.0.0)
    Consider removing this unused package

Ignore Pattern Management

add_ignore_patterns

Adds new patterns to the ignore list for file scanning operations.

Parameters:

  • --patterns (required): Array of glob patterns to ignore (e.g. '.generated.cs', 'bin/')

Example:

dotnet run --project src/NetContextClient/NetContextClient.csproj -- add-ignore-patterns --patterns "*.generated.cs" "bin/*" "obj/*"

clear_ignore_patterns

Removes all user-defined ignore patterns from both memory and the persistent state file.

Parameters: None

Example:

dotnet run --project src/NetContextClient/NetContextClient.csproj -- clear-ignore-patterns

get_ignore_patterns

Retrieves the current list of active ignore patterns from memory.

Parameters: None

Example:

dotnet run --project src/NetContextClient/NetContextClient.csproj -- get-ignore-patterns

get_state_file_location

Returns the absolute path to the ignore_patterns.json state file.

Parameters: None

Example:

dotnet run --project src/NetContextClient/NetContextClient.csproj -- get-state-file-location

remove_ignore_patterns

Removes specific patterns from the ignore list.

Parameters:

  • --patterns (required): Array of glob patterns to remove from the ignore list

Example:

dotnet run --project src/NetContextClient/NetContextClient.csproj -- remove-ignore-patterns --patterns "*.generated.cs" "bin/*"

General Tools

hello

Simple health check endpoint that returns a greeting message.

Parameters: None

Example:

dotnet run --project src/NetContextClient/NetContextClient.csproj -- hello

Default Ignore Patterns

The following patterns are ignored by default to protect sensitive information:

  • *.env - Environment files
  • appsettings.*.json - Application settings
  • *.pfx - Certificate files
  • *.key - Key files
  • *.pem - PEM files
  • *password* - Files containing "password" in the name
  • *secret* - Files containing "secret" in the name

Error Handling

The server provides clear error messages for common scenarios:

  • Directory not found
  • Access denied (outside base directory)
  • Invalid patterns
  • File size limits exceeded
  • Restricted file types
  • Missing environment variables for semantic search