Artemis City MCP 后端

关键词

Obsidian Vault内存管理JSON-RPCAPI Server路由与认证

使用说明（Markdown 格式）

  • 项目简介 Artemis City MCP 后端是一个基于 MCP 的服务器实现，负责提供后端能力给 LLM 客户端使用。它通过一组标准的 MCP 接口（如读取/写入记忆、搜索、管理前置信息、标签等），将 Obsidian 记忆库作为核心知识源，并支持路由、认证和日志的能力，以便让 LLM 客户端以统一的协议访问资源与功能。

  • 主要功能点

    • 提供 MCP 风格的 API 路由：包括读取上下文、追加上下文、更新笔记、搜索笔记、列出笔记、删除笔记、管理前置信息、管理标签、搜索替换等。
    • 内存源与 Obsidian 集成：通过 MemoryClient 与 Obsidian Vault 的 REST 接口进行交互，实现跨会话的记忆与知识持久化。
    • 安全与日志：内置认证中间件，统一日志系统，帮助监控与审计。
    • 路由与扩展性：通过模块化工具与路由器实现对外部工具、资源和记忆的可扩展访问。
    • API 服务器与开发友好：提供 TypeScript 实现、Express 路由，便于本地开发与二次扩展。

  • 安装步骤

    1. 安装运行环境：请确保运行环境含有 Node.js / npm。
    2. 在 mcp-server 目录下安装依赖并准备运行环境（通常执行 npm install）。
    3. 配置环境变量（示例：MCP_API_KEY、OBSIDIAN_BASE_URL、OBSIDIAN_API_KEY）。
    4. 启动 MCP 服务（通常执行 npm run build，然后 npm start，或直接 npm run start 以开发模式启动）。
    5. 服务启动后，服务将监听 MCP 请求并对外提供 /api 路径的 JSON-RPC 风格接口。

  • 服务器配置（MCP 客户端连接信息） 说明：以下为 MCP 客户端连接到服务器的配置信息示例，实际密钥与地址请以你们的部署为准。配置项仅用于描述如何连接服务器，客户端在实际使用中不需要在本仓库中维护该配置文件。

    { "server_name": "Artemis City MCP Server", "command": "npm", "args": ["start"], // 启动服务器的命令，确保在 mcp-server 目录执行 "description": "启动 Artemis City 的 MCP 服务，监听对 Obsidian Vault 的 MCP 请求并对外提供 API。请在部署环境中设置以下环境变量：MCP_API_KEY、OBSIDIAN_BASE_URL、OBSIDIAN_API_KEY。" }

  • 基本使用方法

    • 通过 MCP 客户端向 /api/getContext、/api/appendContext、/api/updateNote 等端点发送 JSON 请求，取得标准化的 MCP 响应。
    • 认证：请求必须携带有效的 MCP API Key（Bearer token，请放在 Authorization 头中）。
    • 记忆与知识源：服务器通过 Obsidian Vault 作为底层知识库，提供跨会话的记忆与知识检索能力。
    • 日志与诊断：服务端日志会记录请求、处理过程与错误，便于排错与性能分析。

  • 运行与调试要点

    • 确保 Obsidian Vault 的 REST API 端点可用且可访问。
    • MCP API Key 与 Vault API Key 必须正确配置，服务才能正常工作。
    • 如需本地调试，可开启开发模式、查看日志输出，确保路由与鉴权功能正确生效。

服务器信息

访问项目