docsapi_key

HackMD

HackMD is a collaborative Markdown workspace for creating, organizing, and sharing personal and team notes.

Verdict

HackMD lets your team draft, retrieve, and organize Markdown notes without leaving Switchy. @mention it to create a new note in your personal workspace or a team folder, pull existing content into a conversation, or move outdated drafts to trash. Writers and product managers who live in Markdown get the most value — you can sketch a spec, ask the AI to refine it, then push the final version back to HackMD in one thread. The MCP reads and writes personal notes reliably; team-workspace features are documented but weren't fully tested, so confirm folder paths before bulk operations.

Common use cases

  • Draft product specs collaboratively in chat
  • Pull meeting notes into standup summaries
  • Archive old drafts to trash in bulk
  • Restore accidentally deleted documentation
  • Organize notes into team folders programmatically

Integration

Vendor
HackMD
Category
docs
Auth
API_KEY
Tools
8
Composio slug
hackmd

Tools

  • Create Note

    Create a Markdown note in the personal workspace or a specified team workspace. The team branch is documented but was not live-tested because the test account belongs to no teams.

  • Get Account

    Return the HackMD profile for the connected token and the teams visible to it. Use the returned team paths with tools that accept team_path.

  • Get Note

    Get a note by ID, including its Markdown content. The personal note route can also retrieve an accessible team note, so no team selector is needed.

  • List Folders

    List all folders in the personal workspace, or in one team workspace when team_path is supplied. Use a folder ID as parent_folder_id when creating a note. The team route is documented but was not live-tested.

  • List Notes

    List all notes in the personal workspace, or in one team workspace when team_path is supplied. HackMD returns the complete collection without pagination; the team route is documented but was not live-tested.

  • List Trash

    List soft-deleted notes in the personal workspace. Team trash is intentionally excluded because it requires team-admin permission and could not be live-tested.

  • Move Note to Trash

    Soft-delete a note by moving it to trash in the personal workspace or an explicitly selected team workspace. This is not permanent deletion. Personal notes can be restored with HACKMD_RESTORE_NOTES; team deletion is documented but was not l

  • Restore Notes

    Restore one or more personal notes from HackMD trash. Returns a per-note success or failure outcome so a partial HTTP 207 result is never reported as an unconditional success.

Setup

Setup guide

  1. 11. In Switchy, open Settings → Integrations and click Connect next to HackMD. 2. You'll be prompted to paste a HackMD API key; generate one at hackmd.io under your account settings (look for Developer or API tokens). 3. Copy the key and paste it into Switchy, then click Authorize. 4. Switchy will call the Get Account tool to confirm the connection and display your username and any visible teams. 5. Open a Project, type '@HackMD list my notes' and send; if you see a list of your recent documents, the integration is live. 6. To create a note, try '@HackMD create a note titled "Sprint 12 Retrospective" with a bullet list of three placeholder topics' — the MCP will return the new note's ID and shareable URL.

What teammates see: by default, memories from HackMD are scoped to the Project (PROJECT visibility) - you can mark any memory PRIVATE or share it ORG-wide.

Works well with

Top models

Compatibility data appears once enough Projects have used this MCP together with a given model.

How Switchy teams use it

Not enough Projects yet to publish anonymised usage stats (we require ≥ 50 Projects per week).

Starter prompts

Draft Release Notes

@HackMD create a note titled 'v2.4 Release Notes' with sections for New Features, Bug Fixes, and Breaking Changes. Under New Features, add placeholder bullets for OAuth support and dark mode.

Retrieve Spec for Review

@HackMD get note ID abc123xyz and summarize the main requirements in three bullet points. Flag any incomplete sections.

List Recent Drafts

@HackMD list all my notes and show the five most recently updated, including their titles and last-modified timestamps.

Clean Up Old Notes

@HackMD list my notes, identify any titled 'Untitled' or older than six months, and move them to trash. Confirm the count before proceeding.

Restore Deleted Draft

@HackMD list my trash, find the note titled 'Q3 Roadmap Draft', and restore it to my personal workspace.

Example outputs

Illustrative - representative of the model's voice and quality, not literal recordings.

Prompt

@hackmd list all my notes and show me which ones were updated in the last week

Output

Found 47 notes in your personal workspace. 6 were modified in the past 7 days: • "Q1 Planning Draft" (updated 2 days ago) • "API Integration Spec" (updated 3 days ago) • "Team Retro Notes - Jan 15" (updated 4 days ago) • "Database Migration Checklist" (updated 5 days ago) • "Customer Feedback Summary" (updated 6 days ago) • "Sprint Goals - Week 3" (updated 6 days ago) This example illustrates the typical response when combining the List Notes tool with date filtering logic. Your actual note titles and timestamps will differ.

Notes

This showcases read-only workspace visibility. The MCP retrieves all personal notes in a single call (no pagination), so large workspaces return immediately. Team notes require the team_path parameter and were not live-tested; personal workspace access is guaranteed with any valid API key.

Prompt

@hackmd create a new note titled "Weekly Standup Template" with sections for Wins, Blockers, and Next Steps

Output

Created note "Weekly Standup Template" in your personal workspace. The note includes three Markdown sections: ## Wins ## Blockers ## Next Steps Note ID: abc123xyz. You can edit it at https://hackmd.io/@youruser/abc123xyz or retrieve the full content with Get Note. This example demonstrates a typical creation response; the actual ID and URL will reflect your account.

Notes

This highlights the Create Note tool's ability to scaffold structured documents. You can optionally place the note in a folder by passing parent_folder_id (use List Folders to find IDs). Team workspace creation requires team_path and appropriate permissions; the personal workspace is always writable.

Prompt

@hackmd get the content of my "API Integration Spec" note and summarize the authentication requirements

Output

Retrieved "API Integration Spec" (note ID: def456ghi). The authentication section specifies: • OAuth 2.0 with PKCE flow for web clients • API key authentication for server-to-server calls • JWT tokens expire after 1 hour; refresh tokens valid for 30 days • Rate limit: 100 requests per minute per key This example shows how the Get Note tool returns full Markdown content, which the AI can then parse and synthesize. Your note's actual authentication details will vary.

Notes

This pairs the Get Note tool with AI reasoning to extract specific information from long documents. The MCP fetches the raw Markdown; the AI handles interpretation. Note IDs are stable, so you can reference the same note across multiple prompts. Trash recovery is supported for personal notes via Restore Notes.

Use-case deep-dives

Meeting notes at 6-person startup

When HackMD beats Google Docs for standup capture

A 6-person startup runs daily standups and wants AI to pull action items from the notes. HackMD wins here because the Create Note and Get Note tools let Switchy write meeting summaries directly into the team's shared workspace, then read them back to extract tasks or blockers. The Markdown format means no formatting drift, and the 8-tool scope keeps the AI focused on note CRUD without wandering into comment threads or version history. The trade-off: HackMD has no inline task management, so if your team needs to assign owners or due dates inside the doc, you'll still export to Linear or Asana. If your workflow is capture-then-triage, HackMD is the right call.

Customer support knowledge base sync

Why HackMD works for support teams under 15 agents

A 12-agent support team maintains troubleshooting guides in HackMD and wants AI to update them after each escalation. The List Notes and Get Note tools let Switchy scan the knowledge base for outdated steps, then Create Note or update existing docs with new workarounds. The API_KEY auth means every agent can grant Switchy access without IT provisioning, and the folder structure (via List Folders) keeps product-line guides organized. The boundary: HackMD has no search ranking or analytics, so if your KB has 200+ articles and you need to surface the most-viewed docs, Notion or Confluence will serve you better. For teams that treat docs as living Markdown files and want fast AI edits, HackMD delivers.

Sprint retro synthesis across 3 squads

HackMD for multi-team retro rollup at mid-size scale

Three product squads (18 people total) write retros in separate HackMD team workspaces, and the PM wants AI to synthesize themes across all three. The Get Account tool reveals which teams the token can see, then List Notes pulls retros from each team_path, and Get Note fetches the Markdown for analysis. The 8-tool kit is lean enough that Switchy won't try to edit permissions or manage trash, keeping the scope on read-then-summarize. The catch: the team routes weren't live-tested in this integration, so if your squads use team workspaces heavily, verify the team_path parameter works in your environment before committing. For orgs where retros live in personal or lightly-shared spaces, this is a clean fit.

Frequently asked

What does the HackMD MCP let me do in Switchy?

It lets your AI agents create, read, list, and trash Markdown notes in your HackMD workspace. Agents can pull existing notes into context, generate new documentation directly in HackMD, or organize notes into folders. The MCP works with personal workspaces out of the box; team workspace support is documented but requires a team-enabled API key.

Do I need a paid HackMD plan to use this MCP?

No. The MCP uses HackMD's API key authentication, which is available on free accounts. You generate the key in your HackMD settings under API, then paste it into Switchy. Team workspace features require a HackMD team subscription, but personal workspace access works on any plan tier.

Can the MCP permanently delete notes or only move them to trash?

It can only soft-delete notes by moving them to trash. Permanent deletion isn't exposed through HackMD's API. The MCP can restore personal notes from trash, but team trash requires admin permissions and isn't supported. If you need to purge notes completely, do it manually in the HackMD web UI.

Should I use this MCP or just have agents write Markdown files locally?

Use the MCP if your team already collaborates in HackMD and you want agents to contribute to the same shared workspace. Use local Markdown if you're building a knowledge base that lives in version control or doesn't need HackMD's real-time editing features. The MCP is overkill for one-off documentation tasks.

Who on my team should connect the HackMD integration?

Whoever owns the HackMD workspace where you want agents to create notes. That person generates the API key and connects it in Switchy. If you're using team workspaces, the key inherits that user's team permissions, so choose someone with write access to the relevant teams.

More docs MCPs

See all docs MCPs →

Data last verified 61 hours ago.Sources aggregated hourly to weekly. See docs/architecture/model-directory.md.