Skip to content

Commit 6ecdbc2

Browse files
feat: update readme and pages
1 parent b53566d commit 6ecdbc2

File tree

3 files changed

+26
-20
lines changed

3 files changed

+26
-20
lines changed

README.md

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -28,30 +28,30 @@ MCPM provides a comprehensive CLI built with Python's Click framework. Below are
2828
### Basic Commands
2929

3030
```
31-
mcpm --help # Display help information and available commands
32-
mcpm --version # Display the current version of MCPM
31+
mcpm --help # Display help information and available commands
32+
mcpm --version # Display the current version of MCPM
3333
```
3434

3535
### Available Commands
3636

3737
```
38-
mcpm client # Show the current active MCP client
39-
mcpm client CLIENT_NAME # Set a new active MCP client
40-
mcpm client --list # List all supported MCP clients and their status
38+
mpcm add SERVER_NAME # Add an MCP server to the active client
39+
mcpm add SERVER_NAME --alias ALIAS_NAME # Add an MCP server to the active client with a custom alias
4140
42-
mcpm edit # View or edit the active MCP client's configuration file
41+
mcpm client # Show the current active MCP client
42+
mcpm client CLIENT_NAME # Set a new active MCP client
43+
mcpm client --list # List all supported MCP clients and their status
4344
44-
mcpm list # List all installed MCP servers
45+
mcpm edit # View or edit the active MCP client's configuration file
4546
46-
mcpm remove SERVER_NAME # Remove an installed MCP server
47+
mcpm list # List all installed MCP servers
4748
48-
mcpm server # Manage MCP server processes
49-
mcpm server start SERVER_NAME # Start an MCP server
50-
mcpm server stop SERVER_NAME # Stop an MCP server
51-
mcpm server restart SERVER_NAME # Restart an MCP server
52-
mcpm server status # Show status of running MCP servers
49+
mcpm remove SERVER_NAME # Remove an installed MCP server
5350
54-
mcpm toggle SERVER_NAME # Toggle an MCP server on or off for a client
51+
mcpm stash SERVER_NAME # Temporarily disable an MCP server for a client
52+
mcpm pop SERVER_NAME # Re-enable an MCP server for a client
53+
54+
mcpm inspect SERVER_NAME # Launch the MCPM Inspector UI to examine servers
5555
```
5656

5757
### Registry
@@ -103,7 +103,7 @@ mcpm.sh/
103103

104104
1. Clone the repository
105105
```
106-
git clone https://github.com/getmcp-xyz/mcpm.sh.git
106+
git clone https://github.com/pathintegral-institute/mcpm.sh.git
107107
cd mcpm.sh
108108
```
109109

@@ -121,7 +121,7 @@ mcpm.sh/
121121
4. Run the CLI directly during development
122122
```
123123
# Either use the installed package
124-
mcp --help
124+
mcpm --help
125125
126126
# Or use the development script
127127
./test_cli.py --help
@@ -136,7 +136,7 @@ mcpm.sh/
136136

137137
- Use the src-based directory structure to prevent import confusion
138138
- Develop with an editable install using `uv pip install -e .`
139-
- Keep commands modular in the `src/mcp/commands/` directory
139+
- Keep commands modular in the `src/mcpm/commands/` directory
140140
- Add tests for new functionality in the `tests/` directory
141141
- Use the `test_cli.py` script for quick development testing
142142

@@ -148,7 +148,7 @@ MCP uses a single source of truth pattern for version management to ensure consi
148148
#### Version Structure
149149

150150
- The canonical version is defined in `version.py` at the project root
151-
- `src/mcp/__init__.py` imports this version
151+
- `src/mcpm/__init__.py` imports this version
152152
- `pyproject.toml` uses dynamic versioning to read from `version.py`
153153
- Git tags are created with the same version number prefixed with 'v' (e.g., v1.0.0)
154154

@@ -170,6 +170,7 @@ When releasing a new version:
170170
3. Create a GitHub release matching the new version
171171

172172
This process ensures that the version is consistent in all places: code, package metadata, and git tags.
173+
PyPI release is handled by the CI/CD pipeline and will be triggered automatically.
173174

174175
## License
175176

pages/index.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -263,6 +263,11 @@ <h2>Quick Installation</h2>
263263
<code><span class="command-prompt">$</span> curl -sSL https://mcpm.sh/install | bash</code>
264264
<button class="copy-button" data-command="curl -sSL https://mcpm.sh/install | bash"><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><rect x="9" y="9" width="13" height="13" rx="2" ry="2"></rect><path d="M5 15H4a2 2 0 0 1-2-2V4a2 2 0 0 1 2-2h9a2 2 0 0 1 2 2v1"></path></svg></button>
265265
</div>
266+
<p>or install from pypi:</p>
267+
<div class="code-block">
268+
<code><span class="command-prompt">$</span> pip install mcpm</code>
269+
<button class="copy-button" data-command="pip install mcpm"><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><rect x="9" y="9" width="13" height="13" rx="2" ry="2"></rect><path d="M5 15H4a2 2 0 0 1-2-2V4a2 2 0 0 1 2-2h9a2 2 0 0 1 2 2v1"></path></svg></button>
270+
</div>
266271
<p>Model Context Protocol Manager (MCPM) is a Homebrew-like service for managing Model Context Protocol (MCP) servers across clients.</p>
267272
</div>
268273

pages/install

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -141,8 +141,8 @@ verify_installation() {
141141
echo
142142
echo -e "${DARK_GREEN}To get started with MCPM, try:${NC}"
143143
echo -e " ${LIGHT_GREEN}mcpm --help${NC} # Show available commands"
144-
echo -e " ${LIGHT_GREEN}mcpm list --available${NC} # List available MCP servers"
145-
echo -e " ${LIGHT_GREEN}mcpm install <server>${NC} # Install an MCP server"
144+
echo -e " ${LIGHT_GREEN}mcpm list${NC} # List local MCP servers"
145+
echo -e " ${LIGHT_GREEN}mcpm add <server>${NC} # Install an MCP server"
146146
echo
147147
echo -e "For more information, visit ${DARK_GREEN}https://mcpm.sh${NC}"
148148
echo

0 commit comments

Comments
 (0)