AI编码规则验证服务器

MarkdownLM MCP Server是一个持久化记忆和管理层,用于在团队和AI编码代理之间执行预定义的规则和模式,确保代码符合架构、安全性和业务逻辑等要求。

  • by MarkdownLM
  • JavaScript
  • 本地部署
  • 17 星标
  • 更新于
在 GitHub 查看 MarkdownLM/mcp

使用说明

MarkdownLM MCP服务器

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编码代理提供了三个专注的工具来查询和验证这些知识。
  3. 代理根据您的规则验证代码 之前 这暗示了变化——违规行为永远不会到达PR。

设置

1.获取API密钥

  1. 登录 MarkdownLM
  2. 首选 设置→ API和MCP
  3. 生成API密钥

2.配置您的AI工具

选择下面的工具。所有使用 相同的npm包 --一个代码库,每个平台。


克劳德代码(CLI)

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

或手动编辑 ~/.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"
      }
    }
  }
}

克劳德桌面版

~/Library/Application Support/Claude/claude_desktop_config.json (macOS)或 %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/mcp.json 在项目根目录中(项目范围内)或 ~/.cursor/mcp.json (全球):

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

帆板运动

~/.codeium/windsurf/mcp_config.json:

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

Cline(VS代码)

在临床扩展设置(MCP服务器)中:

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

VS代码(本机/扩展)

.vscode/mcp.json 在项目根目录中:

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

工具

query_knowledge_base

在编写代码之前,查询团队记录的规则。返回相关规则及其来源,并自动记录未记录决策的差距。

输入

字段 必填 描述
query ✓ 自然语言问题(例如“我应该如何处理身份验证?”)
category ✓ 查询类别: architecture, stack, testing, deployment, security, style, dependencies, error_handling, business_logic, general

响应 — answer, sources[], gap_detected,可选 gap_resolution


validate_code

根据所有记录的规则验证代码段。返回包含违规详细信息和修复建议的通过/失败。

输入

字段 必填 描述
code ✓ 要检查的代码段
task ✓ 代码应该做什么
category ✓ 与此代码相关的知识库类别

响应 — status (pass/fail), violations[] (规则、消息、修复建议), fix_suggestion


resolve_gap

记录未记录决策的知识差距。返回如何根据您的偏好处理它: markdownlm (AI解析), ask_user (等待人类), agent_decide (独立进行)。

输入

字段 必填 描述
question ✓ 未记录的决定或问题
category ✓ 类别提示

响应 — gap_detected, resolution_mode,可选 resolution, gap_id


环境变量

变量 必填 默认 描述
MARKDOWNLM_API_KEY ✓ — 设置中的API密钥→ API和MCP
MARKDOWNLM_API_URL — https://markdownlm.com 覆盖自托管或暂存

速率限制

每位用户每60秒调用100次工具。

日志记录

所有工具调用都记录到 标准错误 作为换行符分隔的JSON(时间戳、工具名称、输入、结果)。这对stdio MCP传输是安全的,可以通过管道传输到任何日志聚合器。

贡献与安全

此存储库严格来说是 桥 (客户),而不是 大脑。为了保护我们的知识产权、基础设施细节和客户数据,请仔细查看我们的 贡献指南 和 安全策略 在进行任何修改之前。

许可证

版权所有(c)2026 MarkdownLM。保留所有权利。