Skip to content

Commit ef44aee

Browse files
authored
Merge pull request #69 from calculus-ask/main
Document Update: Added quick start for Python Package Manager
2 parents 524c33f + 6ad69b4 commit ef44aee

File tree

2 files changed

+35
-0
lines changed

2 files changed

+35
-0
lines changed

docs/docs/overview/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,4 @@ Whether you're integrating REST APIs, local functions, or full LLM agents, MCP G
2525
|------|-------------|
2626
| [Features](features.md) | Breakdown of supported features including federation, transports, and tool wrapping |
2727
| [Admin UI](ui.md) | Screenshots and explanation of the interactive web dashboard |
28+
| [Quick Start](quick_start.md) | Quick Installation and Start up |

docs/docs/overview/quick_start.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Quick Start
2+
3+
Install MCP Context Forge Gateway in local machine using Pypi package and git repository.
4+
5+
6+
## 🐍 Using Python Package Manager (Pypi)
7+
8+
- pip install mcp-contextforge-gateway
9+
- BASIC_AUTH_PASSWORD=password mcpgateway --host 127.0.0.1 --port 4444
10+
11+
## 🛠️ Setup Instructions for mcp-context-forge
12+
13+
1. Fork the Repository
14+
Fork the IBM/mcp-context-forge repository to your own GitHub account.
15+
16+
2. Clone Your Fork
17+
``` git clone https://github.com/<your-username>/mcp-context-forge.git ```
18+
``` cd mcp-context-forge ```
19+
20+
3. Create a Virtual Environment
21+
``` make venv ```
22+
23+
4. Install Dependencies
24+
``` make install ```
25+
26+
5. Start the Development Server
27+
``` make serve ```
28+
29+
6. Access the App
30+
``` http:\\localhost:4444 ```
31+
32+
7. Login Credentials
33+
Username: admin
34+
Password: changeme

0 commit comments

Comments
 (0)