Repository navigation
docs: add Slack assistant, MCP and pentest API guides - #96
Merged
Merged
Conversation
Adds the @hacktron Slack agent page, lists every MCP tool with the REST endpoint it mirrors, documents the new pentest, archive upload, credits, finding counts and stop scan endpoints, and syncs openapi.json from the public spec they ship in. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Sync openapi.json from the fixed public spec (repos schemas now defined), and document that repos is required, changing repos clears the estimate, a changed login reads unverified, start answers 402 without credits, stop returns the scan status, and finding counts list every severity and state. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…s in Slack Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Step-by-step setup for the Slack agent: an admin connects Slack, everyone links their Slack account, add Hacktron AI to a channel or DM it, and connect your Hacktron account on first mention. Adds troubleshooting and points the Slack integration page at the agent setup. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…nav group Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
zeyu2001
marked this pull request as ready for review
October 31, 2026 20:46
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 67703dd078
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
zeyu2001
changed the title
Add the Slack assistant guide and clarify related MCP, API and pentest instructions.
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents how to work with Hacktron from Slack, an MCP client or the REST API. The guides cover finding triage, pentest setup and PR review settings, including account permissions, approval steps and credential handling.
Adds API reference pages for pentest drafts, login checks, estimates, starts, archive uploads, credit balances, finding counts, stopping scans and PR review settings. The OpenAPI specification includes the corresponding operations. The pentest quickstart links to each way to start a scan.
The Slack setup guides use the current Notifications and Personal settings labels, with screenshots beside the workspace connection and account-linking steps.
Validation: Prettier, Mintlify broken-link checks and build validation pass. All 25 OpenAPI references resolve. Browser checks covered the Slack guides, MCP and pentest draft pages at 1440px and 390px, including image loading, page overflow and the account-link heading anchor.
Screenshot provenance: captured the actual frontend components from HacktronAI/web@93c5804091d7ba5c833c743a199109f3be52a8a1 in a local preview with disconnected demo-account fixtures. These are component captures. Slack authorization, notification delivery and pentest execution were not exercised.
Note
Low Risk
Documentation and OpenAPI spec updates only; no runtime or security-sensitive application code changes.
Overview
Documents programmatic and conversational ways to run pentests, triage findings, and manage PR reviews outside the dashboard.
REST API & OpenAPI: Adds Mintlify pages and
openapi.jsonentries for the pentest draft lifecycle (create, update, login checks, estimate, start, discard), archive uploads, credit balance, aggregated finding counts, stop scan, and org/repo PR review settings. Navigation indocs.jsongroups these under Pentests, Credits, and expanded Findings/Repositories/Scans sections.Slack: New Hacktron in Slack guide (
platform/slack-assistant.mdx) for @hacktron AI—setup, approvals, pentest flow, signed-in testing via private forms, and limits. Org and personal Slack docs are refreshed (Personal settings, Integrations UI, link to the assistant).MCP:
mcp/get-started.mdxmaps MCP tools to REST endpoints, documents pentest and PR review tools, role requirements, and a warning about login credentials in assistant chats.Pentest quickstart: Replaces API-only “cost estimation then create scan” with cards for Slack, MCP, create pentest draft, and the existing code-only scan path.
Reviewed by Cursor Bugbot for commit bd49e0b. Bugbot is set up for automated code reviews on this repo. Configure here.