HackMD MCP Server
HackMD MCP 서버
HackMD API 와 상호 작용하는 모델 컨텍스트 프로토콜(MCP) 서버입니다. AI 비서가 다음과 같은 작업을 수행할 수 있도록 지원합니다.
사용자 정보 가져오기
사용자 메모 목록
메모 생성, 읽기, 업데이트 및 삭제
읽은 기록 보기
팀 노트 작업
요구 사항
노드.js 18+
Related MCP server: MCP Kibela
환경 변수
HACKMD_API_TOKEN: [필수] HackMD API 토큰HACKMD_API_URL: (선택 사항) HackMD API 엔드포인트 URL입니다. 기본값:https://api.hackmd.io/v1
HackMD 설정 에서 API 토큰을 얻을 수 있습니다.
Claude Desktop(또는 다른 MCP 클라이언트)에 설치
Smithery를 통해 설치
Smithery를 통해 Claude Desktop에 HackMD MCP 서버를 자동으로 설치하려면:
지엑스피1
mcp-get을 통해 설치
npx @michaellatman/mcp-get@latest install hackmd-mcp수동 설치
claude_desktop_config.json에 이 서버를 추가하세요:
{
"mcpServers": {
"hackmd": {
"command": "npx",
"args": ["-y", "hackmd-mcp"],
"env": {
"HACKMD_API_TOKEN": "your_api_token"
}
}
}
}Claude Desktop을 다시 시작하세요
도구를 사용하여 HackMD 계정과 상호 작용하세요
사용 가능한 도구
사용자 API
get_user_info : 인증된 사용자에 대한 정보를 가져옵니다.
사용자 메모 API
list_user_notes : 사용자가 소유한 모든 노트를 나열합니다.
get_note : ID로 노트를 가져옵니다
create_note : 새로운 노트를 만듭니다
update_note : 기존 노트 업데이트
delete_note : 메모 삭제
get_history : 사용자의 독서 기록을 가져옵니다
팀 API
list_teams : 사용자가 액세스할 수 있는 모든 팀을 나열합니다.
팀 노트 API
list_team_notes : 팀의 모든 노트를 나열합니다
create_team_note : 팀에 새로운 노트를 만듭니다
update_team_note : 팀의 기존 노트를 업데이트합니다.
delete_team_note : 팀에서 메모 삭제
사용 예
Can you help me manage my HackMD notes?그런 다음 다음과 같은 명령을 사용하세요.
Please list all my notes.지역 개발
이 프로젝트는 패키지 관리자로 Bun을 사용합니다. 아직 설치하지 않으셨다면 설치하세요.
저장소를 복제하고 종속성을 설치합니다.
git clone https://github.com/yuna0x0/hackmd-mcp.git
cd hackmd-mcp
bun install구성
다음 예를 복사하여
.env파일을 만듭니다.
cp .env.example .env.env파일을 편집하고 HackMD API 토큰을 추가하세요.
HACKMD_API_TOKEN=your_api_tokenMCP Inspector를 사용한 디버깅
MCP Inspector를 사용하여 HackMD MCP 서버를 테스트하고 디버깅할 수 있습니다.
npx @modelcontextprotocol/inspector -e HACKMD_API_TOKEN=your_api_token npx hackmd-mcp
# Use this instead when Local Development
bun run inspector그런 다음 제공된 URL(일반적으로 http://127.0.0.1:6274 )로 브라우저를 열어 MCP Inspector 인터페이스에 접속하세요. 여기에서 다음 작업을 수행할 수 있습니다.
실행 중인 HackMD MCP 서버에 연결하세요
사용 가능한 도구 찾아보기
사용자 정의 매개변수를 사용하여 도구 실행
응답 보기
이 기능은 Claude나 다른 AI 보조 장치에 연결하기 전에 설정을 테스트하는 데 특히 유용합니다.
도커
Docker Hub에서 가져오기:
docker pull yuna0x0/hackmd-mcpDocker 빌드(로컬 개발):
docker build -t yuna0x0/hackmd-mcp .Docker 다중 플랫폼 빌드(로컬 개발):
docker buildx build --platform linux/amd64,linux/arm64 -t yuna0x0/hackmd-mcp .보안 공지
이 MCP 서버는 .env 파일이나 환경 변수로 HackMD API 토큰을 필요로 합니다. 이 정보를 안전하게 보관하고 버전 관리 시스템에 커밋하지 마세요.
특허
이 프로젝트는 MIT 라이선스에 따라 라이선스가 부여되었습니다. 자세한 내용은 라이선스 파일을 참조하세요.
Available Tools
12 toolscreate_noteCInspect
Create a new note
| Name | Required | Description | Default |
|---|---|---|---|
| payload | Yes | Create note options |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden of behavioral disclosure. 'Create a new note' implies a write/mutation operation but does not disclose any behavioral traits such as authentication requirements, rate limits, side effects, or what happens on success/failure. The description is minimal and fails to provide necessary context for safe invocation.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is extremely concise with a single sentence 'Create a new note'. It is front-loaded and wastes no words, though this conciseness comes at the cost of completeness. Every word earns its place by stating the core action, but it lacks necessary elaboration.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the complexity (a write operation with nested parameters and multiple sibling tools), no annotations, and no output schema, the description is incomplete. It does not explain the return values, error conditions, or how it differs from similar tools like 'create_team_note'. The agent lacks sufficient context to use this tool effectively in a real scenario.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, with detailed descriptions for all nested parameters (e.g., 'Note content', 'Note title', permission enums). The description adds no parameter information beyond what the schema provides, but the schema is comprehensive. According to rules, baseline is 3 when schema coverage is high (>80%) and no param info is in the description.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description 'Create a new note' is a tautology that restates the tool name without adding specificity. It does not distinguish this tool from its sibling 'create_team_note' or explain what type of note is being created (e.g., personal vs. team). The verb 'create' is clear but lacks context about the resource scope.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides no guidance on when to use this tool versus alternatives like 'create_team_note' or 'update_note'. There is no mention of prerequisites, target context (e.g., personal notes vs. team notes), or any explicit when/when-not instructions. This leaves the agent without usage context.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
create_team_noteCInspect
Create a new note in a team
| Name | Required | Description | Default |
|---|---|---|---|
| payload | Yes | Create note options | |
| teamPath | Yes | Team path |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden of behavioral disclosure. It states the tool creates a note, implying a write operation, but doesn't cover critical aspects like authentication requirements, rate limits, error conditions, or what happens on success (e.g., returns a note ID). For a mutation tool, this leaves significant gaps in understanding its behavior.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, efficient sentence with zero waste—it directly states the tool's purpose without unnecessary words. It's appropriately sized for a simple creation tool and front-loaded with the core action, making it easy to parse quickly.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity (a mutation with nested parameters) and lack of annotations and output schema, the description is incomplete. It doesn't explain return values, error handling, or behavioral nuances like permission implications, which are crucial for safe and effective use. This leaves the agent with insufficient context to invoke the tool correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, with all parameters well-documented in the schema (e.g., 'teamPath' as 'Team path', 'payload' with nested properties like 'content' as 'Note content'). The description adds no additional parameter information beyond what the schema provides, so it meets the baseline score of 3 for high schema coverage.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the action ('Create a new note') and resource ('in a team'), which distinguishes it from sibling tools like 'create_note' that presumably create notes in a different context. However, it doesn't explicitly differentiate from 'update_team_note' or 'list_team_notes' beyond the verb, leaving some ambiguity about sibling relationships.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides no guidance on when to use this tool versus alternatives like 'create_note' or 'update_team_note'. It doesn't mention prerequisites, such as needing team access or permissions, or clarify scenarios where this tool is preferred over others in the sibling list.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
delete_noteCInspect
Delete a note
| Name | Required | Description | Default |
|---|---|---|---|
| noteId | Yes | Note ID |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries full burden. It states 'Delete a note' which implies a destructive mutation, but doesn't disclose behavioral traits like whether deletion is permanent, requires specific permissions, has side effects, or returns confirmation. This is a significant gap for a mutation tool with zero annotation coverage.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is extremely concise with just three words, front-loaded and zero waste. It efficiently communicates the core action without unnecessary elaboration, making it easy to parse quickly.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity (a destructive mutation), lack of annotations, and no output schema, the description is incomplete. It fails to address critical aspects like return values, error conditions, or behavioral nuances, leaving the agent with insufficient information for reliable use.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema has 1 parameter with 100% description coverage ('Note ID'), so the schema fully documents it. The description doesn't add any parameter details beyond what the schema provides, but with 0 parameters needing extra explanation, a baseline of 4 is appropriate as no compensation is required.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description 'Delete a note' clearly states the action (delete) and resource (note), but it's vague about scope and doesn't distinguish from sibling tools like delete_team_note. It provides basic purpose but lacks specificity about what kind of note it deletes (e.g., personal vs. team).
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance is provided on when to use this tool versus alternatives like delete_team_note or update_note. The description doesn't mention prerequisites, such as needing an existing note ID, or exclusions, leaving the agent to infer usage from context alone.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
delete_team_noteCInspect
Delete a note in a team
| Name | Required | Description | Default |
|---|---|---|---|
| noteId | Yes | Note ID | |
| teamPath | Yes | Team path |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden of behavioral disclosure. It states the tool deletes a note but doesn't mention critical aspects like whether deletion is permanent, requires specific permissions, has side effects (e.g., affecting team history), or provides confirmation. This leaves significant gaps for a destructive operation.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, efficient sentence with zero waste. It is front-loaded and appropriately sized for a simple tool, making it easy to parse quickly.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's destructive nature, no annotations, and no output schema, the description is incomplete. It fails to address behavioral risks (e.g., irreversible deletion), response expectations, or error handling, which are crucial for safe agent invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, with both parameters ('noteId' and 'teamPath') documented in the schema. The description adds no additional meaning beyond the schema, such as format examples or relationships between parameters. Baseline 3 is appropriate as the schema handles parameter documentation.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description 'Delete a note in a team' clearly states the action (delete) and resource (note in a team), distinguishing it from sibling tools like 'delete_note' (which likely deletes a note without team context). However, it doesn't specify whether this is a permanent deletion or if notes can be restored, which slightly limits specificity.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides no guidance on when to use this tool versus alternatives like 'delete_note' or 'update_team_note'. It lacks context on prerequisites (e.g., needing the note ID and team path) or exclusions (e.g., not for deleting notes outside teams).
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_historyCInspect
Get user's reading history
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries full burden for behavioral disclosure. 'Get user's reading history' implies a read-only operation, but it doesn't specify authentication requirements, rate limits, whether it returns structured data or raw text, error conditions, or if it's cached. For a tool with zero annotation coverage, this leaves significant behavioral gaps unaddressed.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, efficient sentence: 'Get user's reading history'. It's front-loaded with the core action and resource, with no wasted words or redundant phrasing. Every word earns its place by conveying the essential purpose without unnecessary elaboration.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the lack of annotations and output schema, the description is incomplete for effective tool use. It doesn't explain what 'reading history' entails (e.g., articles, books, timestamps), the return format, or how it relates to sibling tools like note management functions. For a data retrieval tool with no structured output definition, more context is needed to understand what the agent will receive.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema has 0 parameters with 100% coverage, meaning no parameters need documentation. The description doesn't mention any parameters, which is appropriate since none exist. It doesn't add semantic details beyond the schema, but with zero parameters, the baseline is 4 as the description doesn't need to compensate for any gaps.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description 'Get user's reading history' states the action (get) and resource (reading history), but it's vague about scope and format. It doesn't specify whether this returns recent items, all-time history, paginated results, or what fields are included. Compared to sibling tools like 'get_note' or 'get_user_info', it lacks differentiation in what makes this specific reading history retrieval unique.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides no guidance on when to use this tool versus alternatives. With sibling tools like 'list_user_notes' or 'get_user_info', there's no indication whether this tool is for personal history only, team-related history, or how it differs from other data retrieval tools. No prerequisites, exclusions, or contextual recommendations are mentioned.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_noteCInspect
Get a note by its ID
| Name | Required | Description | Default |
|---|---|---|---|
| noteId | Yes | Note ID |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden of behavioral disclosure. 'Get a note by its ID' implies a read-only operation, but it doesn't specify whether authentication is required, what happens if the ID is invalid (e.g., error handling), or the format of the returned note. For a tool with zero annotation coverage, this leaves significant behavioral gaps.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, efficient sentence with zero waste. It's front-loaded with the core purpose and appropriately sized for a simple retrieval tool. Every word earns its place without redundancy or unnecessary elaboration.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the lack of annotations and output schema, the description is incomplete for a retrieval tool. It doesn't explain what a 'note' contains, the return format, error conditions, or authentication needs. While the tool is simple (one parameter), the description fails to provide enough context for reliable agent use without additional inference.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema description coverage is 100%, with the single parameter 'noteId' documented as 'Note ID' in the schema. The description adds no additional meaning beyond what the schema provides (e.g., no examples, format hints, or constraints). With high schema coverage, the baseline score of 3 is appropriate as the description doesn't compensate but also doesn't detract.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description 'Get a note by its ID' clearly states the verb 'Get' and resource 'note', with the specific condition 'by its ID' that distinguishes it from list operations. However, it doesn't explicitly differentiate from sibling tools like get_history or get_user_info, which also retrieve data by ID but for different resources.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides no guidance on when to use this tool versus alternatives. It doesn't mention prerequisites (e.g., needing a valid note ID), when not to use it (e.g., for listing notes), or direct alternatives like list_user_notes for browsing. The agent must infer usage from the tool name and context alone.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_user_infoBInspect
Get information about the authenticated user
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden of behavioral disclosure. It mentions 'authenticated user' which implies some authentication requirement, but doesn't specify what information is returned, potential rate limits, error conditions, or other behavioral traits. This leaves significant gaps for an agent to understand how to use it effectively.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, efficient sentence that communicates the core purpose without any wasted words. It's appropriately sized for a simple tool and front-loads the essential information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a tool with no annotations and no output schema, the description is insufficiently complete. It doesn't explain what type of user information is returned, the format of the response, or any behavioral constraints. Given the lack of structured data elsewhere, the description should provide more context about what the agent can expect.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool has 0 parameters with 100% schema description coverage, so the schema already fully documents the parameter situation. The description appropriately doesn't waste space discussing non-existent parameters, earning a baseline score of 4 for not adding unnecessary information.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool's purpose with a specific verb ('Get') and resource ('information about the authenticated user'), making it immediately understandable. However, it doesn't differentiate from sibling tools like 'get_history' or 'get_note', which prevents a perfect score.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides no guidance on when to use this tool versus alternatives like 'list_user_notes' or 'get_history', nor does it mention any prerequisites or exclusions. It simply states what the tool does without contextual usage advice.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_team_notesCInspect
List all notes in a team
| Name | Required | Description | Default |
|---|---|---|---|
| teamPath | Yes | Team path |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries full burden but only states the basic action. It doesn't disclose behavioral traits like whether it's read-only, pagination behavior, error conditions, or rate limits. This is inadequate for a tool with potential complexity.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, efficient sentence with zero waste. It's appropriately sized and front-loaded, clearly stating the core functionality without unnecessary elaboration.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given no annotations, no output schema, and multiple sibling tools, the description is incomplete. It doesn't explain return values, error handling, or how it differs from similar tools, leaving significant gaps for an agent to operate effectively.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema description coverage is 100%, so the schema already documents the 'teamPath' parameter. The description implies team-based filtering but adds no meaning beyond what the schema provides, such as format examples or constraints. Baseline 3 is appropriate here.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the action ('List') and resource ('notes in a team'), making the purpose understandable. However, it doesn't differentiate from sibling tools like 'list_teams' or 'list_user_notes' beyond the 'team' scope, which prevents a perfect score.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides no guidance on when to use this tool versus alternatives like 'list_user_otes' or 'get_note'. It lacks context about prerequisites, such as needing a valid team path, or exclusions, leaving the agent to infer usage from the name alone.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_teamsBInspect
List all teams accessible to the user
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries full burden but only states the basic action. It doesn't disclose behavioral traits such as pagination, rate limits, authentication requirements, or what 'accessible to the user' entails (e.g., permissions, visibility rules). This leaves significant gaps for agent decision-making.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, efficient sentence that front-loads the core purpose without any wasted words. It's appropriately sized for a simple list tool with no parameters.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the lack of annotations and output schema, the description is incomplete. It doesn't explain what the output looks like (e.g., list format, fields included), behavioral constraints, or how 'accessible' is determined. For a tool with no structured metadata, more context is needed.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool has 0 parameters, and schema description coverage is 100%, so there's no need for parameter details in the description. The description appropriately avoids redundant information, earning a baseline high score for this dimension.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the action ('List') and resource ('teams') with the scope 'accessible to the user', making the purpose immediately understandable. It doesn't explicitly distinguish from siblings like 'list_team_notes' or 'list_user_notes', but the resource focus is clear enough for basic differentiation.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides no guidance on when to use this tool versus alternatives like 'list_team_notes' or 'list_user_notes', nor does it mention prerequisites or context for usage. It simply states what it does without indicating when it's appropriate.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_user_notesBInspect
List all notes owned by the user
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries full burden for behavioral disclosure. It states it's a list operation but doesn't describe return format, pagination, sorting, error conditions, or authentication requirements. 'List all notes' implies it might return a potentially large dataset without filtering options, but this isn't explicitly stated.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, clear sentence with zero wasted words. It's front-loaded with the core purpose and doesn't include unnecessary elaboration. Every word earns its place in conveying the essential function.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a tool with no annotations and no output schema, the description is insufficient. It doesn't explain what 'notes' are, what fields they contain, how they're formatted, or what 'owned by the user' means operationally. The agent would need to guess about the return structure and behavioral characteristics.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool has 0 parameters with 100% schema description coverage, so the schema already fully documents the parameter situation. The description appropriately doesn't discuss parameters since none exist, earning a baseline 4 for not creating confusion about non-existent parameters.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb ('List') and resource ('notes owned by the user'), making the purpose immediately understandable. It distinguishes from sibling tools like 'list_team_notes' by specifying 'user' scope, though it doesn't explicitly contrast with 'list_team_notes' in the description text itself.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides no guidance on when to use this tool versus alternatives like 'list_team_notes' or 'get_note'. It doesn't mention prerequisites, limitations, or typical use cases, leaving the agent to infer usage from the name alone.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
update_noteCInspect
Update an existing note
| Name | Required | Description | Default |
|---|---|---|---|
| noteId | Yes | Note ID | |
| payload | Yes | Update note options |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden of behavioral disclosure. It states 'Update an existing note,' which implies a mutation operation, but doesn't cover aspects like permissions required, whether changes are reversible, rate limits, or what happens to unspecified fields. For a mutation tool with zero annotation coverage, this is a significant gap in transparency.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, efficient sentence with zero waste, front-loading the core action. It's appropriately sized for the tool's complexity, making it easy to parse quickly without unnecessary elaboration.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity as a mutation with nested parameters and no annotations or output schema, the description is incomplete. It lacks details on behavioral traits, usage context, and return values, which are crucial for an agent to invoke this tool correctly and understand its effects.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema description coverage is 100%, so the schema already documents both parameters ('noteId' and 'payload') and their nested properties. The description adds no additional meaning beyond what the schema provides, such as explaining the purpose of 'payload' or the effects of updates. Baseline 3 is appropriate when the schema does the heavy lifting.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states the action ('Update') and resource ('an existing note'), making the basic purpose clear. However, it doesn't differentiate from sibling tools like 'update_team_note' or specify what aspects can be updated beyond the generic term. The description is functional but lacks specificity about scope or distinction from alternatives.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance is provided on when to use this tool versus alternatives such as 'update_team_note' or 'create_note', nor are prerequisites like needing an existing note ID mentioned. The description implies usage for updates but offers no context about exclusions or comparisons with sibling tools, leaving the agent to infer based on tool names alone.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
update_team_noteCInspect
Update an existing note in a team
| Name | Required | Description | Default |
|---|---|---|---|
| noteId | Yes | Note ID | |
| options | Yes | Update note options | |
| teamPath | Yes | Team path |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden of behavioral disclosure. While 'Update' implies a mutation operation, the description doesn't specify what happens on success/failure, whether changes are reversible, what permissions are required, or any rate limits. For a mutation tool with zero annotation coverage, this leaves significant behavioral gaps.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, efficient sentence that states the core functionality without any wasted words. It's appropriately sized for a straightforward update operation and gets directly to the point.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given this is a mutation tool with no annotations and no output schema, the description is insufficiently complete. It doesn't explain what the tool returns, what error conditions might occur, or any behavioral nuances. The agent lacks critical information needed to properly invoke and handle responses from this tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents all three parameters thoroughly. The description adds no additional parameter information beyond what's in the schema. According to scoring rules, when schema coverage is high (>80%), the baseline is 3 even with no param info in the description.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the action ('Update') and resource ('an existing note in a team'), making the purpose immediately understandable. However, it doesn't differentiate this tool from its sibling 'update_note' (which likely updates notes in a different context), leaving some ambiguity about when to use one versus the other.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides no guidance on when to use this tool versus alternatives. With sibling tools like 'update_note' and 'create_team_note' available, there's no indication of prerequisites, appropriate contexts, or distinctions between these similar operations. The agent must infer usage from the name alone.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
12 tool updates
v1.0.0- First observed
create_note - First observed
create_team_note - First observed
delete_note - First observed
delete_team_note - First observed
get_history - First observed
get_note - First observed
get_user_info - First observed
list_team_notes - First observed
list_teams - First observed
list_user_notes - First observed
update_note - First observed
update_team_note
TDQS
Scored across 12 tools
Every tool has a clearly distinct purpose with no ambiguity. The tools are well-organized around specific resources (notes, teams, user info, history) and actions (create, get, list, update, delete), making it easy for an agent to select the correct tool without confusion.
All tool names follow a consistent verb_noun pattern (e.g., create_note, list_teams, get_user_info). The naming is uniform across the set, with no deviations in style or convention, ensuring predictability and readability.
With 12 tools, the count is well-scoped for a HackMD server, covering core operations for notes, teams, and user management. Each tool earns its place by addressing specific needs without being excessive or insufficient for the domain.
The tool set provides complete CRUD/lifecycle coverage for notes (including team-specific variants) and teams, along with user info and history. There are no obvious gaps, enabling agents to handle all essential workflows without dead ends.
Maintenance
Related MCP Connectors
A comprehensive Model Context Protocol (MCP) server that enables AI assistants to interact with yo…
Google Keep-style notes app with an MCP server for AI agents to read/write notes.
Markdown-based note-taking with a hosted MCP server. Your notes serve you and your AI.
A Model Context Protocol server for Wix AI tools
Related MCP Servers
- AlicenseBqualityFmaintenanceA Model Context Protocol server that enables AI assistants to read, write, and manipulate notes in your Obsidian vault through a standardized interface.52,886 npm4ISC
- AlicenseAqualityCmaintenanceA Model Context Protocol server that enables AI assistants to search and access information stored in Kibela, supporting note search, retrieval, creation and updating.611 npm13MIT
- -licenseNot gradedqualityNot gradedmaintenanceA Model Context Protocol server that enables AI assistants to interact with Notion's API for reading, creating, and modifying Notion content through natural language interactions.-
- FlicenseNot gradedqualityDmaintenanceA Model Context Protocol server that allows AI assistants like Claude to interact with Evernote, enabling them to create, search, read, and manage notes through natural language.4-