Skip to content

Commit 0f6bcf5

Browse files
authored
docs: slim up the README (#83)
1 parent e1f0f3b commit 0f6bcf5

File tree

1 file changed

+4
-39
lines changed

1 file changed

+4
-39
lines changed

README.md

Lines changed: 4 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
</h1>
66

77
<p align="center">
8-
Detect and list MCPs in your local dev environment (Model Context Protocol)
8+
Detect Configured MCP (Model Context Protocol) in your local dev environment
99
</p>
1010

1111
<p align="center">
@@ -24,48 +24,17 @@
2424

2525
## Features
2626

27-
- **🔍 MCP Discovery**: Automatically detect MCP servers across multiple AI applications
28-
- **📁 Directory Bubbling**: Intelligent discovery of project-scoped MCP configs from nested directories
27+
- **🔍 MCP Discovery**: Automatically detect MCP servers across various AI applications and agentic IDEs
28+
- **📁 Directory Bubbling**: Intelligent discovery of project-scoped MCP configs from nested directories, supporting project-scoped MCP Server configuration and global configurations
2929
- **🔄 Process Detection**: Real-time status of running MCP servers
30-
- **🔒 Credential Analysis**: Security analysis of environment variables and API keys
31-
- **🌐 URL Hostname Extraction**: Clean display of hostnames for URL-based MCP servers
32-
- **🌍 Cross-Platform**: Support for Windows and macOS (Linux support coming soon)
33-
- **⚡ High Performance**: Fast discovery with intelligent caching and optimization
30+
- **🔒 Credential Analysis**: Security analysis of environment variables and API keys for potentially exposed credentials in MCP Servers
3431

3532
## Usage: CLI
3633

3734
```bash
3835
npx ls-mcp
3936
```
4037

41-
### Directory Bubbling
42-
43-
The tool now includes intelligent directory bubbling for better Developer Experience. Run `ls-mcp` from anywhere in your project structure:
44-
45-
```bash
46-
# From project root (traditional behavior)
47-
cd ~/projects/my-project
48-
npx ls-mcp
49-
50-
# From nested directory (new feature!)
51-
cd ~/projects/my-project/backend/services/api
52-
npx ls-mcp # Automatically finds .vscode/mcp.json from project root
53-
```
54-
55-
### URL Hostname Extraction
56-
57-
The tool now displays clean hostnames for URL-based MCP servers instead of full URLs:
58-
59-
```bash
60-
# Before: Full URLs cluttered the SOURCE column
61-
SOURCE | STATUS | NAME | TRANSPORT
62-
http://localhost:3000/mcp || local-server | http
63-
64-
# After: Clean hostnames for better readability
65-
SOURCE | STATUS | NAME | TRANSPORT
66-
localhost || local-server | http
67-
```
68-
6938
### Debug Mode
7039

7140
To enable verbose debugging output, set the `NODE_DEBUG` environment variable:
@@ -89,10 +58,6 @@ For detailed information about the project architecture and features:
8958
- **[URL Hostname Extraction](./docs/url-hostname-extraction.md)**: Clean display of hostnames for URL-based servers
9059
- **[Credential Detection](./docs/credential-detection.md)**: Security analysis features
9160

92-
## Contributing
93-
94-
Please consult [CONTRIBUTING](./.github/CONTRIBUTING.md) for guidelines on contributing to this project.
95-
9661
## Author
9762

9863
**ls-mcp** © [Liran Tal](https://github.com/lirantal), Released under the [Apache-2.0](./LICENSE) License.

0 commit comments

Comments
 (0)