Skip to main content
Glama
alioshr
by alioshr

存储库 MCP 服务器

铁匠徽章 npm 版本 npm 下载

受Cline Memory Bank启发,用于远程存储库管理的模型上下文协议 (MCP) 服务器实现。

概述

记忆库 MCP 服务器将传统的基于文件的记忆库转变为集中式服务,其功能如下:

  • 通过 MCP 协议提供对存储库文件的远程访问

  • 支持多项目存储库管理

  • 保持一致的文件结构和验证

  • 确保项目存储库之间适当隔离

Related MCP server: AgentMemory Offline

特征

  • 多项目支持

    • 项目特定目录

    • 文件结构强制执行

    • 路径遍历预防

    • 项目列表功能

    • 每个项目的文件列表

  • 远程访问

    • 完整的 MCP 协议实现

    • 类型安全操作

    • 正确的错误处理

    • 通过项目隔离实现安全

  • 核心运营

    • 读取/写入/更新存储库文件

    • 列出可用项目

    • 列出项目中的文件

    • 项目存在验证

    • 安全的只读操作

安装

要通过Smithery自动为 Claude Desktop 安装 Memory Bank Server:

npx -y @smithery/cli install @alioshr/memory-bank-mcp --client claude

这将自动设置 MCP 服务器配置。或者,您可以按照下面“配置”部分中的说明手动配置服务器。

快速入门

  1. 在您的设置中配置 MCP 服务器(请参阅下面的配置部分)

  2. 开始使用 AI 助手中的存储库工具

配置

存储库 MCP 服务器需要在您的 Cline MCP 设置文件中进行配置。具体位置取决于您的设置:

  • 对于 Cline 扩展: ~/Library/Application Support/Cursor/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json

  • 对于 Roo Code VS Code 扩展: ~/Library/Application Support/Code/User/globalStorage/rooveterinaryinc.roo-cline/settings/mcp_settings.json

  • 对于 Claude 桌面应用程序: ~/Library/Application Support/Claude/claude_desktop_config.json

将以下配置添加到您的 MCP 设置中:

{
  "allpepper-memory-bank": {
    "command": "npx",
    "args": ["-y", "@allpepper/memory-bank-mcp"],
    "env": {
      "MEMORY_BANK_ROOT": "<path-to-bank>"
    },
    "disabled": false,
    "autoApprove": [
      "memory_bank_read",
      "memory_bank_write",
      "memory_bank_update",
      "list_projects",
      "list_project_files"
    ]
  }
}

配置详细信息

  • MEMORY_BANK_ROOT :存储项目存储库的目录(例如, /path/to/memory-bank )

  • disabled :设置为false以启用服务器

  • autoApprove :不需要明确用户批准的操作列表:

    • memory_bank_read :读取存储库文件

    • memory_bank_write :创建新的存储库文件

    • memory_bank_update :更新现有的存储库文件

    • list_projects :列出可用的项目

    • list_project_files :列出项目中的文件

对于光标

对于 Cursor,打开设置 -> 功能 -> 添加 MCP 服务器 -> 添加以下内容:

env MEMORY_BANK_ROOT=<path-to-bank> npx -y @allpepper/memory-bank-mcp@latest

自定义 IA 指令

本节包含应粘贴到 AI 自定义指令(适用于 Cline、Claude、Cursor 或任何其他 MCP 客户端)上的说明。请复制并粘贴这些规则。有关参考,请参阅包含这些规则的custom-instructions.md文件。

发展

基本开发命令:

# Install dependencies
npm install

# Build the project
npm run build

# Run tests
npm run test

# Run tests in watch mode
npm run test:watch

# Run the server directly with ts-node for quick testing
npm run dev

使用 Docker 运行

  1. 构建 Docker 镜像:

    docker build -t memory-bank-mcp:local .
  2. 运行Docker容器进行测试:

    docker run -i --rm \
      -e MEMORY_BANK_ROOT="/mnt/memory_bank" \
      -v /path/to/memory-bank:/mnt/memory_bank \
      --entrypoint /bin/sh \
      memory-bank-mcp:local \
      -c "ls -la /mnt/memory_bank"
  3. 添加 MCP 配置,以 Roo 代码为例:

    "allpepper-memory-bank": {
      "command": "docker",
      "args": [
        "run", "-i", "--rm",
        "-e", 
        "MEMORY_BANK_ROOT",
        "-v", 
        "/path/to/memory-bank:/mnt/memory_bank",
        "memory-bank-mcp:local"
      ],
      "env": {
        "MEMORY_BANK_ROOT": "/mnt/memory_bank"
      },
      "disabled": false,
      "alwaysAllow": [
        "list_projects",
        "list_project_files",
        "memory_bank_read",
        "memory_bank_update",
        "memory_bank_write"
      ]
    }

贡献

欢迎贡献!请按以下步骤操作:

  1. 分叉存储库

  2. 创建功能分支( git checkout -b feature/amazing-feature )

  3. 提交您的更改( git commit -m 'Add amazing feature' )

  4. 推送到分支( git push origin feature/amazing-feature )

  5. 打开拉取请求

开发指南

  • 所有新代码均使用 TypeScript

  • 维护整个代码库的类型安全

  • 添加新功能测试

  • 根据需要更新文档

  • 遵循现有的代码风格和模式

测试

  • 为新功能编写单元测试

  • 包括多项目场景测试

  • 彻底测试错误案例

  • 验证类型约束

  • 适当地模拟文件系统操作

执照

该项目根据 MIT 许可证获得许可 - 有关详细信息,请参阅LICENSE文件。

致谢

该项目实现了Cline Memory Bank中最初记录的存储库概念,并通过远程功能和多项目支持对其进行了扩展。

Available Tools

5 tools
list_project_filesA

List all files within a specific project

ParametersJSON Schema
NameRequiredDescriptionDefault
projectNameYesThe name of the project

TDQS

A3.8/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden. It conveys the core read-only behavior, but it does not mention the shape of the returned file list, recursion, error behavior for unknown projects, or any side effects. It is minimal but not contradictory.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single front-loaded sentence with no filler or repetition. Every word adds meaning relative to the tool's purpose.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

This is a simple 1-parameter, read-only list operation with no output schema. The description accurately conveys the essential function and scope. It omits details like file-entry shape and recursive behavior, but these are minor gaps for a tool of this complexity.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, and the schema already describes the parameter as 'The name of the project.' The description adds essentially no new meaning about how 'projectName' is used or validated, so it stays at the baseline of 3.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states the action clearly ('list all files'), the resource ('files'), and the scope ('within a specific project'). It is distinguishable from siblings: 'list_projects' enumerates projects, while 'memory_bank_*' operate on the memory bank.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no explicit guidance about when to choose this tool over siblings such as 'list_projects' or 'memory_bank_read'. The context implies it is used to inspect files inside a known project, but the caveats and alternatives are not stated.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

list_projectsB

List all projects in the memory bank

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

TDQS

B3.3/5.0
Behavior2/5

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 implies a read-only operation through the word 'list', but doesn't disclose whether results are paginated, sorted, or complete; nor does it mention any potential side effects or limitations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, concise sentence that front-loads the action and resource. Every word is informative, and it is appropriately sized for a parameterless list operation.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple parameterless list operation, this description covers the core usage. However, the complete lack of detail about the return format or any read behavior means an agent must rely on the server response to learn the output structure, and given the absence of annotations and output schema, slightly more context could be useful.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The tool has zero parameters, so the description doesn't need to explain parameters. The schema confirms this, meeting the baseline for tools with no parameters.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

Description includes a specific verb ('list'), resource ('projects'), and scope ('in the memory bank'), making the purpose clear. It doesn't explicitly distinguish itself from siblings like list_project_files, but the target resource is different enough that an agent can infer the distinction.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance is provided about when to use this tool over alternatives. It only says 'List all projects in the memory bank' and gives no context about use cases, ordering, or relationship to memory_bank_read or list_project_files.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

memory_bank_readB

Read a memory bank file for a specific project

ParametersJSON Schema
NameRequiredDescriptionDefault
fileNameYesThe name of the file
projectNameYesThe name of the project

TDQS

B3.2/5.0
Behavior1/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description must carry the full burden of behavioral disclosure. It only repeats the action 'Read' without revealing any side effects, error handling, prerequisites, or return format. It offers no additional behavioral context beyond the tool's name.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence that directly states the purpose without any waste. It is front-loaded and every word earns its place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple read tool with two parameters and no output schema, the description is minimal. It does not mention what the return value looks like, any potential errors (e.g., missing file or project), or any prerequisites. This leaves the agent without critical context needed to fully anticipate the tool's behavior.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100% with both parameters clearly named in the schema. The tool description adds no extra meaning about the parameters beyond the schema's basic descriptions. Baseline 3 is appropriate since the schema already covers parameter semantics.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states a specific verb ('Read') and a resource ('memory bank file') scoped to a project. It unambiguously distinguishes from siblings like list_projects, list_project_files, memory_bank_write, and memory_bank_update, which have different purposes.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage for reading file content, but it does not explicitly state when to use this tool versus alternatives or provide any exclusions. There is no guidance on when not to use it or when a sibling would be more appropriate, leaving usage to inference.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

memory_bank_updateC

Update an existing memory bank file for a specific project

ParametersJSON Schema
NameRequiredDescriptionDefault
contentYesThe content of the file
fileNameYesThe name of the file
projectNameYesThe name of the project

TDQS

C2.9/5.0
Behavior2/5

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 only says 'Update', which indicates a mutation, but does not state whether the update fully replaces the file content, what happens if the file does not exist (error vs. create), or any side effects. No permissions, reversibility, or error handling are mentioned. The description is too terse to give the agent confidence about the operation's behavior.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, focused sentence with no filler or redundancy. It conveys the core purpose efficiently and is appropriately front-loaded with the verb and object. Nothing extraneous is present, and the length is appropriate for a simple tool.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given that the tool is a mutation with no safety annotations and simple parameters, the description should clarify the prerequisite (file must exist) and the difference from memory_bank_write. It does not mention that the file must exist or that the operation might fail if it does not. While the schema covers parameters, the description leaves out important context about when and how to use this tool safely, making it incomplete for an agent to invoke correctly in all cases.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema already provides 100% coverage of all parameters with straightforward descriptions ('The content of the file', 'The name of the file', 'The name of the project'). The description adds no additional meaning or context about parameter usage, formatting, or dependencies. Since the schema does the heavy lifting, the baseline score of 3 is appropriate; the description adds no real enhancement.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('Update') and the resource ('existing memory bank file for a specific project'). It distinguishes itself from siblings through the word 'existing', implying it modifies files that already exist rather than creating new ones. However, it does not explicitly name the alternative tool (memory_bank_write) or explain the difference explicitly, so it is clear but not fully differentiated.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no explicit guidance on when to use this tool versus alternatives. It implies that the file must already exist (via the word 'existing'), but it does not say 'use this for updates only, use memory_bank_write for new files'. An agent is left to infer the usage context from the sibling tool names. This is minimal guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

memory_bank_writeC

Create a new memory bank file for a specific project

ParametersJSON Schema
NameRequiredDescriptionDefault
contentYesThe content of the file
fileNameYesThe name of the file
projectNameYesThe name of the project

TDQS

C2.9/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description must disclose behavioral traits. It only says 'create', with no mention of whether an existing file would be overwritten, permissions needed, or error scenarios. It does not say what happens if the project doesn't exist or if there are constraints. This is a significant gap for a write operation.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, concise sentence with no fluff. It is front-loaded with the primary action and resource. It earns a high conciseness score, though it could have been slightly more informative without becoming verbose.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 3-parameter write tool with no output schema, the description is minimal but somewhat sufficient given the schema covers all params. However, it lacks details about failure modes, idempotency, or how it relates to sibling tools. An agent might need more context to handle edge cases correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, with each parameter having a basic description ('The content of the file', etc.). However, the tool description adds no additional meaning beyond what the schema already states. Baseline is 3 because the schema does the heavy lifting; the description does not enhance parameter understanding.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('Create') and resource ('a new memory bank file'), and specifies it's for a specific project. It distinguishes from siblings like memory_bank_update by using 'new', though it doesn't explicitly name alternatives. This is clear but lacks explicit sibling differentiation.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

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. It doesn't mention that it's for creating new files only, nor does it reference update/read tools. An agent must infer usage from the name and description 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.

  1. 5 tool updatesv0.2.1
    • First observedlist_project_files
    • First observedlist_projects
    • First observedmemory_bank_read
    • First observedmemory_bank_update
    • First observedmemory_bank_write

TDQS

B3.4/5.0

Scored across 5 tools

Disambiguation5/5

Each tool targets a distinct resource and action: listing projects, listing files within a project, reading a file, creating a file, and updating a file. There is no overlap or ambiguity between tools.

Naming Consistency3/5

Names mix two conventions: 'list_projects' and 'list_project_files' use verb-first snake_case, while 'memory_bank_read', 'memory_bank_write', and 'memory_bank_update' use object-first with a modifier. The pattern is inconsistent but still readable.

Tool Count5/5

Five tools is well-scoped for a memory bank server, covering the essential operations without unnecessary bloat. The count feels right for the domain.

Completeness3/5

The server covers list, read, create, and update of memory bank files, but it is missing a delete operation. This is a notable gap in CRUD coverage, though agents can work around it by archiving or overwriting files.

Maintenance

ActivityInactive
ResponsivenessUnresponsive

Related MCP Connectors

Related MCP Servers