MM

markdownlm/mcp

开发工具官方

本页由 AI 翻译,技术细节请以原文为准。 查看原文

17 stars 6 forks 质量 71 趋势 9NOASSERTION

markdownlm/mcp 是从 https://github.com/markdownlm/mcp. 导入的 MCP 服务器候选

概览

markdownlm/mcp 是从 https://github.com/markdownlm/mcp. 导入的 MCP 服务器候选

概述(AI 翻译)

MarkdownLM 是你的团队与 AI 编码代理之间的持久内存和治理层。定义一次规则。在所有地方强制执行。每一次会话。

注:

MarkdownLM 知识库支持以下类别,涵盖所有规则、模式和决策:

  • architecture:分层、边界、系统设计
  • stack:框架、库、版本
  • testing:测试框架、覆盖范围、模式
  • deployment:CI/CD、平台、脚本
  • security:认证、验证、秘密
  • style:命名、格式、组织
  • dependencies:已批准/禁用的包
  • error_handling:例外、日志记录、监控
  • business_logic:领域规则、工作流约束、业务不变、定价逻辑、订阅规则、权限模型
  • general:还有其他吗?

使用该MCP服务器时,务必指定类别。category是query_knowledge_base上的必填字段。

它是如何运作的

  1. 你的团队在 MarkdownLM 中记录架构规则、堆栈决策和模式。
  2. 该MCP服务器为AI编码代理提供了三种针对性质询和验证的工具,用于查询和验证这些知识。

本页由 AI 翻译,技术细节请以原文为准。

README

以下为原文 README 节选,完整内容请查看原文。

MarkdownLM MCP Server

MarkdownLM is the persistent memory and governance layer between your team and your AI coding agents. Define your rules once. Enforced everywhere. Every session.

Note:

The MarkdownLM knowledge base supports the following categories for all rules, patterns, and decisions:

  • architecture: Layering, boundaries, system design
  • stack: Frameworks, libraries, versions
  • testing: Test frameworks, coverage, patterns
  • deployment: CI/CD, platforms, scripts
  • security: Auth, validation, secrets
  • style: Naming, formatting, organization
  • dependencies: Approved/banned packages
  • error_handling: Exceptions, logging, monitoring
  • business_logic: Domain rules, workflow constraints, business invariants, pricing logic, subscription rules, permission models
  • general: Anything else

When using this MCP server, always specify a category. category is a required field on query_knowledge_base.

How it works

  1. Your team documents architecture rules, stack decisions, and patterns in MarkdownLM.
  2. This MCP server gives AI coding agents three focused tools to query and validate against that knowledge.
  3. Agents validate code against your rules before suggesting changes — violations never reach PRs.

Setup

1. Get your API key

  1. Log in to MarkdownLM
  2. Go to Settings → API & MCP
  3. Generate an API key

2. Configure your AI tool

Pick your tool below. All use the same npm package — one codebase, every platform.


Claude Code (CLI)

claude mcp add markdownlm -e MARKDOWNLM_API_KEY=mdlm_your_key_here -e MARKDOWNLM_API_URL=https://markdownlm.com -- npx -y markdownlm-mcp

Or manually edit ~/.claude/claude_code_config.json:

{
  "mcpServers": {
    "markdownlm": {
      "command": "npx",
      "args": ["-y", "markdownlm-mcp"],
      "env": {
        "MARKDOWNLM_API_KEY": "mdlm_your_key_here",
        "MARKDOWNLM_API_URL": "https://markdownlm.com"
      }
    }
  }
}

Claude Desktop

~/Library/Application Support/Claude/claude_desktop_config.json (macOS) or %APPDATA%/Claude/claude_desktop_config.json (Windows):

{
  "mcpServers": {
    "markdownlm": {
      "command": "npx",
      "args": ["-y", "markdownlm-mcp"],
      "env": {
        "MARKDOWNLM_API_KEY": "mdlm_your_key_here",
        "MARKDOWNLM_API_URL": "https://markdownlm.com"
      }
    }
  }
}

Cursor

.cursor/mcp.json in your project root (project-scoped) or ~/.cursor/mcp.json (global):

{
  "mcpServers": {
    "markdownlm": {
      "command": "npx",
      "args": ["-y", "markdownlm-mcp"],
      "env": {
        "MARKDOWNLM_API_KEY": "mdlm_your_key_here",
        "MARKDOWNLM_API_URL": "https://markdownlm.com"
      }
    }
  }
}

Windsurf

~/.codeium/windsurf/mcp_config.json:

在 GitHub 查看完整 README

安装

npx -y markdownlm-mcp
新手?先看 mcpskill.org 教程 →

配置

{ "mcpServers": { "markdownlm": { "command": "npx", "args": ["-y", "markdownlm-mcp"], "env": { "MARKDOWNLM_API_KEY": "mdlm_your_key_here", "MARKDOWNLM_API_URL": "https://markdownlm.com" } } } }