# HackMD

```json
{
  "name": "HackMD",
  "slug": "hackmd",
  "url": "https://composio.dev/toolkits/hackmd",
  "markdown_url": "https://composio.dev/toolkits/hackmd.md",
  "logo_url": "https://logos.composio.dev/api/hackmd",
  "categories": [
    "document & file management"
  ],
  "is_composio_managed": false,
  "updated_at": "2026-08-20T15:32:13.557Z"
}
```

![HackMD logo](https://logos.composio.dev/api/hackmd)

## Description

Securely connect your AI agents and chatbots (Claude, ChatGPT, Cursor, etc) with HackMD MCP or direct API to create notes, update Markdown docs, organize team workspaces, and share collaborative notes through natural language.

## Summary

HackMD is a collaborative Markdown workspace for personal and team notes.
Use it to write, organize, and share living docs without leaving Markdown.

## Categories

- document & file management

## Toolkit Details

- Tools: 8

## Images

- Logo: https://logos.composio.dev/api/hackmd

## Authentication

- **Api Key**
  - Type: `api_key`
  - Description: Api Key authentication for HackMD.
  - Setup:
    - Configure Api Key credentials for HackMD.
    - Use the credentials when creating an auth config in Composio.

## Suggested Prompts

- Create a HackMD meeting notes draft
- Summarize my latest HackMD team notes
- Share HackMD onboarding checklist with engineering

## Supported Tools

| Tool slug | Name | Description |
|---|---|---|
| `HACKMD_CREATE_NOTE` | 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. |
| `HACKMD_GET_ACCOUNT` | 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. |
| `HACKMD_GET_NOTE` | 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. |
| `HACKMD_LIST_FOLDERS` | 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. |
| `HACKMD_LIST_NOTES` | 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. |
| `HACKMD_LIST_TRASH` | 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. |
| `HACKMD_MOVE_NOTE_TO_TRASH` | 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 live-verified, and no team restore endpoint is mapped. |
| `HACKMD_RESTORE_NOTES` | 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. |

## Supported Triggers

None listed.

## Installation and MCP Setup

### Path 1: SDK Installation

#### Path 1, Step 1: Install Composio

Install the Composio SDK
```python
pip install composio_openai
```

```typescript
npm install @composio/openai
```

#### Path 1, Step 2: Initialize Composio and Create Tool Router Session

Import and initialize Composio client, then create a Tool Router session
```python
from openai import OpenAI
from composio import Composio
from composio_openai import OpenAIResponsesProvider

composio = Composio(provider=OpenAIResponsesProvider())
openai = OpenAI()
session = composio.create(user_id='your-user-id')
```

```typescript
import OpenAI from 'openai';
import { Composio } from '@composio/core';
import { OpenAIResponsesProvider } from '@composio/openai';

const composio = new Composio({
  provider: new OpenAIResponsesProvider(),
});
const openai = new OpenAI({});
const session = await composio.create('your-user-id');
```

#### Path 1, Step 3: Execute HackMD Tools via Tool Router with Your Agent

Get tools from Tool Router session and execute HackMD actions with your Agent
```python
tools = session.tools
response = openai.responses.create(
  model='gpt-4.1',
  tools=tools,
  input=[{
    'role': 'user',
    'content': 'Create a HackMD note titled Project Kickoff with agenda and action items'
  }]
)
result = composio.provider.handle_tool_calls(
  response=response,
  user_id='your-user-id'
)
print(result)
```

```typescript
const tools = session.tools;
const response = await openai.responses.create({
  model: 'gpt-4.1',
  tools: tools,
  input: [{
    role: 'user',
    content: 'Create a HackMD note titled Project Kickoff with agenda and action items'
  }],
});
const result = await composio.provider.handleToolCalls(
  'your-user-id',
  response.output
);
console.log(result);
```

### Path 2: MCP Server Setup

#### Path 2, Step 1: Install Composio

Install the Composio SDK for Python or TypeScript
```python
pip install composio claude-agent-sdk
```

```typescript
npm install @composio/core ai @ai-sdk/openai @ai-sdk/mcp
```

#### Path 2, Step 2: Initialize Client and Create Tool Router Session

Import and initialize the Composio client, then create a Tool Router session for HackMD
```python
from composio import Composio
from claude_agent_sdk import ClaudeSDKClient, ClaudeAgentOptions

composio = Composio(api_key='your-composio-api-key')
session = composio.create(user_id='your-user-id')
url = session.mcp.url
```

```typescript
import { Composio } from '@composio/core';

const composio = new Composio({ apiKey: 'your-api-key' });
const session = await composio.create('your-user-id');
console.log(`Tool Router session created: ${session.mcp.url}`);
```

#### Path 2, Step 3: Connect to AI Agent

Use the MCP server with your AI agent (Anthropic Claude or Mastra)
```python
import asyncio

options = ClaudeAgentOptions(
    permission_mode='bypassPermissions',
    mcp_servers={
        'tool_router': {
            'type': 'http',
            'url': url,
            'headers': {
                'x-api-key': 'your-composio-api-key'
            }
        }
    },
    system_prompt='You are a helpful assistant with access to HackMD tools.',
    max_turns=10
)

async def main():
    async with ClaudeSDKClient(options=options) as client:
        await client.query('Create a HackMD note titled Project Kickoff with agenda and action items')
        async for message in client.receive_response():
            if hasattr(message, 'content'):
                for block in message.content:
                    if hasattr(block, 'text'):
                        print(block.text)

asyncio.run(main())
```

```typescript
import { openai } from '@ai-sdk/openai';
import { experimental_createMCPClient as createMCPClient } from '@ai-sdk/mcp';
import { generateText } from 'ai';

const client = await createMCPClient({
  transport: {
    type: 'http',
    url: session.mcp.url,
    headers: {
      'x-api-key': 'your-composio-api-key',
    },
  },
});

const tools = await client.tools();
const { text } = await generateText({
  model: openai('gpt-4o'),
  tools,
  messages: [{
    role: 'user',
    content: 'Create a HackMD note titled Project Kickoff with agenda and action items'
  }],
  maxSteps: 5,
});

console.log(`Agent: ${text}`);
```

## Why Use Composio?

### 1. AI Native HackMD Integration

- Supports both HackMD MCP and direct API based integrations
- Structured, LLM-friendly schemas so agents can work with Markdown notes more reliably
- Rich coverage for creating, reading, updating, and sharing HackMD notes

### 2. Managed Auth

- Secure API key handling, so you don't need to hard-code HackMD credentials
- Central place to manage, scope, and revoke HackMD access
- Per user and per environment credentials for safer team and production setups

### 3. Agent Optimized Design

- Tools are tuned using real error and success rates to improve reliability over time
- Clear tool schemas help agents understand when to create, edit, or fetch HackMD notes
- Comprehensive execution logs so you always know what ran, when, and on whose behalf

### 4. Enterprise Grade Security

- Fine-grained RBAC so you control which agents and users can access HackMD
- Scoped, least privilege access to HackMD notes and workspaces
- Full audit trail of agent actions to support review and compliance

## Use HackMD with any AI Agent Framework

Choose a framework you want to connect HackMD with:

None listed.

## Related Toolkits

- [Google Drive](https://composio.dev/toolkits/googledrive) - Google Drive is a cloud storage platform for uploading, sharing, and collaborating on files. It's perfect for keeping your documents accessible and organized across devices.
- [Google Docs](https://composio.dev/toolkits/googledocs) - Google Docs is a cloud-based word processor that enables document creation and real-time collaboration. Its seamless sharing and version history make team editing and content management a breeze.
- [Google Super](https://composio.dev/toolkits/googlesuper) - Google Super is an all-in-one suite combining Gmail, Drive, Calendar, Sheets, Analytics, and more. It gives you a unified platform to manage your digital life, boosting productivity and organization.
- [ActiveMerge](https://composio.dev/toolkits/active_merge) - ActiveMerge is a document automation platform for generating documents, images, merged files, and e-signature workflows. It helps teams turn templates and stored files into finished, shareable documents faster.
- [Affinda](https://composio.dev/toolkits/affinda) - Affinda is an AI-powered document processing platform that automates data extraction from resumes, invoices, and more. It streamlines document-heavy workflows by turning files into structured, actionable data.
- [Agility cms](https://composio.dev/toolkits/agility_cms) - Agility CMS is a headless content management system for building and managing digital experiences across platforms. It lets teams update content quickly and deliver omnichannel experiences with ease.
- [Airparser](https://composio.dev/toolkits/airparser) - Airparser is an AI-powered parser for extracting structured data from emails, documents, PDFs, and files. It turns messy inbound content into clean fields your apps and workflows can use.
- [Algodocs](https://composio.dev/toolkits/algodocs) - Algodocs is an AI-powered platform that automates data extraction from business documents. It delivers fast, secure, and accurate processing without templates or manual training.
- [Api2pdf](https://composio.dev/toolkits/api2pdf) - Api2Pdf is a REST API for generating PDFs from HTML, URLs, and documents using powerful engines like wkhtmltopdf and Headless Chrome. It streamlines document conversion and automation for developers and businesses.
- [Aryn](https://composio.dev/toolkits/aryn) - Aryn is an AI-powered platform for parsing, extracting, and analyzing data from unstructured documents. Use it to automate document processing and unlock actionable insights from your files.
- [Boldsign](https://composio.dev/toolkits/boldsign) - Boldsign is a digital eSignature platform for sending, signing, and tracking documents online. Organizations use it to automate agreements and manage legally binding workflows efficiently.
- [Boloforms](https://composio.dev/toolkits/boloforms) - BoloForms is an eSignature platform built for small businesses, offering unlimited signatures, templates, and forms. It simplifies digital document signing and team collaboration at a predictable, fixed price.
- [Box](https://composio.dev/toolkits/box) - Box is a cloud content management and file sharing platform for businesses. It helps teams securely store, organize, and collaborate on files from anywhere.
- [Carbone](https://composio.dev/toolkits/carbone) - Carbone is a blazing-fast report generator that turns JSON data into PDFs, Word docs, spreadsheets, and more using flexible templates. It lets you automate document creation at scale with minimal code.
- [Castingwords](https://composio.dev/toolkits/castingwords) - CastingWords is a transcription service specializing in human-powered, accurate transcripts via a simple API. Get seamless audio-to-text conversion for interviews, meetings, podcasts, and more.
- [CertSeal](https://composio.dev/toolkits/cert_seal) - CertSeal is an API platform for issuing and managing verifiable digital certificates. Use it to automate trusted certificate workflows for recipients, batches, designs, and webhooks.
- [Cloudconvert](https://composio.dev/toolkits/cloudconvert) - CloudConvert is a powerful file conversion service supporting over 200 file formats. It streamlines converting, compressing, and managing documents, media, and more, all in one place.
- [Cloudlayer](https://composio.dev/toolkits/cloudlayer) - Cloudlayer is a document and asset generation service for creating PDFs and images via API or SDKs. It lets you automate high-quality doc creation, saving dev time and reducing manual work.
- [CloudPDF](https://composio.dev/toolkits/cloud_pdf) - CloudPDF is an API platform for creating, uploading, managing, and sharing PDF documents. Use it to build secure PDF workflows with webhooks, share links, and access control.
- [Cloudpress](https://composio.dev/toolkits/cloudpress) - Cloudpress is a content export tool for Google Docs and Notion. It automates publishing to your favorite Content Management Systems.

## Frequently Asked Questions

### Do I need my own developer credentials to use HackMD with Composio?

Yes, HackMD requires you to configure your own API key credentials. Once set up, Composio handles secure credential storage and API request handling for you.

### Can I use multiple toolkits together?

Yes! Composio's Tool Router enables agents to use multiple toolkits. [Learn more](https://docs.composio.dev/tool-router/overview).

### Is Composio secure?

Composio is SOC 2 and ISO 27001 compliant with all data encrypted in transit and at rest. [Learn more](https://trust.composio.dev).

### What if the API changes?

Composio maintains and updates all toolkit integrations automatically, so your agents always work with the latest API versions.

---
[See all toolkits](https://composio.dev/toolkits) · [Composio docs](https://docs.composio.dev/llms.txt)