Skip to content

Commit c5b9369

Browse files
authored
Merge pull request #2 from netwrix/update-readme-tools
Update tool names in README
2 parents d2d287e + 1cb0881 commit c5b9369

File tree

1 file changed

+17
-27
lines changed

1 file changed

+17
-27
lines changed

README.md

Lines changed: 17 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# MCP Server for Claude Desktop
1+
# MCP Server for Netwrix Access Analyzer
22

33
A FastMCP-based server for Netwrix Access Analyzer data analysis, designed to integrate with Claude Desktop for enhanced data analysis capabilities.
44

@@ -45,10 +45,10 @@ For development or testing purposes only:
4545

4646
```
4747
# Database Connection Information
48-
DB_SERVER=your_server_name # e.g., 192.168.50.220
49-
DB_NAME=your_database_name # e.g., StealthAudit
50-
DB_USER=your_username # e.g., sa
51-
DB_PASSWORD=your_password # e.g., PASSWORD
48+
DB_SERVER=your_server_name
49+
DB_NAME=your_database_name
50+
DB_USER=your_username
51+
DB_PASSWORD=your_password
5252
DB_USE_WINDOWS_AUTH=FALSE # Set to TRUE to use Windows Authentication
5353
```
5454

@@ -97,7 +97,7 @@ The MCP server provides the following tools for interacting with database system
9797

9898
### Database Connection Tools
9999

100-
#### connect_database
100+
#### Connect-Database
101101

102102
Connect to a MS SQL Server database.
103103

@@ -111,7 +111,7 @@ Connect to a MS SQL Server database.
111111
**Example prompt:**
112112
"Connect to our SQL Server database at [DBSERVER] with the name [DBNAME] using the [USERNAME] user and [PASSWORD] password."
113113

114-
#### show_connection_status
114+
#### Show-ConnectionStatus
115115

116116
Check the current database connection status.
117117

@@ -120,17 +120,7 @@ Check the current database connection status.
120120

121121
### Data Query and Schema Tools
122122

123-
#### run_query
124-
125-
Execute a custom SQL query on the connected database.
126-
127-
**Parameters:**
128-
- `query`: SQL query string
129-
130-
**Example prompt:**
131-
"Run this SQL query: SELECT TOP 10 * FROM Permissions ORDER BY LastAccessTime DESC"
132-
133-
#### explain_table
123+
#### Show-TableSchema
134124

135125
Get a detailed explanation of a database table's schema.
136126

@@ -140,7 +130,7 @@ Get a detailed explanation of a database table's schema.
140130
**Example prompt:**
141131
"Explain the schema of the Permissions table. What columns does it have?"
142132

143-
#### get_table_schema
133+
#### Get-TableSchema
144134

145135
Retrieves the schema information for a specific table.
146136

@@ -150,7 +140,7 @@ Retrieves the schema information for a specific table.
150140
**Example prompt:**
151141
"Show me the schema for the Users table."
152142

153-
#### get_table_sample
143+
#### Get-TableSample
154144

155145
Retrieves a sample of 10 rows from the specified table.
156146

@@ -162,14 +152,14 @@ Retrieves a sample of 10 rows from the specified table.
162152

163153
### Access Analysis Tools
164154

165-
#### get_sensitivedata
155+
#### Discover-SensitiveData
166156

167157
Identify locations containing sensitive data.
168158

169159
**Example prompt:**
170160
"Find all shares that contain sensitive data in our environment."
171161

172-
#### get_trustee_access
162+
#### Get-TrusteeAccess
173163

174164
Identify where a specific user or group has access.
175165

@@ -180,7 +170,7 @@ Identify where a specific user or group has access.
180170
**Example prompt:**
181171
"Where does DOMAIN\JohnDoe have access in our file systems?"
182172

183-
#### get_permission_source
173+
#### Get-TrusteePermissionSource
184174

185175
Determine the source of a user's permissions for a specific resource.
186176

@@ -191,7 +181,7 @@ Determine the source of a user's permissions for a specific resource.
191181
**Example prompt:**
192182
"Why does DOMAIN\JaneDoe have access to \\server\share\folder? What's the source of this permission?"
193183

194-
#### get_resource_access
184+
#### Get-ResourceAccess
195185

196186
Show who has access to a specific resource.
197187

@@ -201,7 +191,7 @@ Show who has access to a specific resource.
201191
**Example prompt:**
202192
"Who has access to \\server\finance? Show me all users and groups."
203193

204-
#### get_unused_access
194+
#### Get-UnusedAccess
205195

206196
Find users with unused access to a specific resource.
207197

@@ -211,7 +201,7 @@ Find users with unused access to a specific resource.
211201
**Example prompt:**
212202
"Find all users who haven't accessed \\server\hr in the last year."
213203

214-
#### get_shadow_access
204+
#### Get-ShadowAccess
215205

216206
Find users with shadow access to critical resources.
217207

@@ -221,7 +211,7 @@ Find users with shadow access to critical resources.
221211

222212
### Operational Tools
223213

224-
#### get_running_jobs
214+
#### Get-RunningJobs
225215

226216
Check currently running Netwrix Access Analyzer jobs.
227217

0 commit comments

Comments
 (0)