Skip to content

Commit 849995b

Browse files
authored
Merge pull request #120 from ThePorgs/dev
My-resources minor refacto, adding MCP in contribution list, and minor edits
2 parents e4b88b6 + 6519c93 commit 849995b

File tree

8 files changed

+99
-98
lines changed

8 files changed

+99
-98
lines changed

docs/.vitepress/config.mts

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,10 @@ function sidebarContribute(): SidebarItemWithBadge[] {
171171
{
172172
text: "Components",
173173
items: [
174+
{
175+
text: "Docs",
176+
link: "docs"
177+
},
174178
{
175179
text: "Images",
176180
link: "images"
@@ -192,9 +196,9 @@ function sidebarContribute(): SidebarItemWithBadge[] {
192196
link: "exegol-history"
193197
},
194198
{
195-
text: "Docs",
196-
link: "docs"
197-
}
199+
text: "Exegol MCP",
200+
link: "exegol-mcp"
201+
}
198202
]
199203
},
200204
{

docs/src/contribute/exegol-history.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Contributing to Exegol-history
22

3-
`Exegol-history` is a tool to quickly store and retrieve compromised credentials and hosts during penetration testing engagements or CTFs. For more information about using the tool, see the [Exegol-history documentation](/images/exegol-history).
3+
Exegol-history is a tool to quickly store and retrieve compromised credentials and hosts during penetration testing engagements or CTFs.
4+
5+
For more information about using the tool, see the [Exegol-history documentation](/images/exegol-history).
46

57
> [!NOTE]
68
> This subproject is still in early development and may change significantly. Stable documentation and contribution guidelines will be added as the project matures.

docs/src/contribute/exegol-mcp.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Contributing to Exegol MCP
2+
3+
Exegol MCP is a Model Context Protocol (MCP) server that enables AI assistants and agents to interact with Exegol. This service allows AI clients (such as Cursor, Claude Desktop, etc.) to use Exegol and work on offensive security tasks such as Capture The Flag, penetration testing, etc.
4+
5+
For more information about using the tool, see the [Exegol MCP documentation](/mcp/features).
6+
7+
> [!NOTE]
8+
> This subproject is still in early development and may change significantly. Stable documentation and contribution guidelines will be added as the project matures.
9+
10+
## Getting started
11+
12+
1. Fork the [Exegol-MCP](https://github.com/ThePorgs/Exegol-MCP) repository
13+
2. Checkout the `dev` branch (if any, `main` branch else)
14+
3. (optional) create a new branch in your fork, if you plan on working on different topics
15+
4. Create your content using this guide
16+
5. Make sure your changes work locally
17+
6. Stage, Commit, and Push your changes
18+
7. Submit a Pull Request

0 commit comments

Comments
 (0)