Lspace 可让你从任何 AI 会话中捕获见解,并立即在所有工具中使用这些见解,从而消除上下文切换的摩擦,将零散的对话转化为持久且可搜索的知识。
本指南将帮助你设置 Lspace 服务器,并将其配置为与 Model Context Protocol (MCP) 客户端(如 Cursor 或 Claude Desktop)配合使用。
以下步骤将准备好 Lspace 服务器代码,以便供 MCP 客户端执行。
git clone https://github.com/Lspace-io/lspace-server.git
cd lspace-server
npm install
dist/
文件夹中):npm run build
构建完成后,MCP 服务器的主脚本将是该目录根目录下的 lspace-mcp-server.js
。
在 MCP 客户端使用 Lspace 之前,你需要对 Lspace 本身进行配置:
.env
文件):
cp .env.example .env
- 编辑新的 `.env` 文件。
- **至关重要的是,设置你的 `OPENAI_API_KEY`**。
- 根据需要查看并调整其他变量(请参阅 `.env.example` 中的注释)。
config.local.json
文件):
cp config.example.json config.local.json
- 编辑 `config.local.json`:
- 在 `credentials.github_pats` 下添加你的 GitHub PAT。如果你需要创建 PAT 的详细说明,请参阅下面的 [了解适用于 Lspace 的 GitHub 个人访问令牌 (PAT)](#了解适用于-lspace-的-github-个人访问令牌-pats) 部分。
- 在 `repositories` 数组下定义 Lspace 应管理的本地或 GitHub 仓库。
- 有关详细结构和示例,请参阅“手动管理仓库 (`config.local.json`)”部分。
lspace-mcp-server.js
脚本(位于你的 lspace-server
目录中)是 MCP 客户端将执行的脚本。你需要告知 MCP 客户端如何找到并运行此脚本。
⚠️ 重要提示
在以下客户端配置中,请将
/actual/absolute/path/to/your/lspace-server/
替换为你克隆并构建lspace-server
的目录的实际绝对文件路径。
.cursor/mcp.json
文件。~/.cursor/mcp.json
文件。Cursor 的示例 mcp.json
文件如下:
{
"mcpServers": {
"lspace-knowledge-base": { // 你可以在此处选择任何名称
"command": "node",
"args": ["/actual/absolute/path/to/your/lspace-server/lspace-mcp-server.js"],
"env": {
// lspace-server 目录中的 .env 文件应会自动被拾取。
// 仅当你需要为 Cursor 专门覆盖这些环境变量,或者未找到 .env 文件时,才在此处添加环境变量。
// "OPENAI_API_KEY": "your_openai_key_if_not_in_lspace_env"
}
}
}
}
- 请记住替换 `args` 中的占位符路径。
- 创建或修改此配置后,重启 Cursor。
~/Library/Application Support/Claude/claude_desktop_config.json
%APPDATA%\\Claude\\claude_desktop_config.json
如果此文件不存在,当你转到“设置”>“开发者”>“编辑配置”时,Claude Desktop 可能会创建它。
Claude Desktop 的示例 claude_desktop_config.json
内容如下:
{
"mcpServers": {
"lspace": { // 你可以在此处选择任何名称
"command": "node",
"args": ["/actual/absolute/path/to/your/lspace-server/lspace-mcp-server.js"]
// "env": { ... } // 与 Cursor 类似的环境变量考虑因素
}
}
}
- 确保你替换 `args` 中的占位符路径。
- 保存此文件的更改后,重启 Claude Desktop。
配置完 MCP 客户端后,它应该能够启动并与你的 Lspace 服务器进行通信,从而允许你在客户端中使用 Lspace 工具并访问已配置的知识库。
Lspace 需要 GitHub 个人访问令牌 (PATs) 才能代表你与 GitHub 仓库进行交互。这包括克隆仓库、读取内容,以及重要的是,通过提交和推送更改来写入新内容(例如,生成的知识库文章、处理后的原始输入)等操作。
PATs 是一种安全的方式,可在不需要你密码的情况下授予 Lspace 访问你 GitHub 账户的权限。你可以控制授予每个 PAT 的权限(范围),并随时撤销它们。
repo
范围。此范围授予对公共和私有仓库的完全控制权。
config.local.json
)在你的 config.local.json
文件中,你将在 credentials.github_pats
部分为你的 PAT 定义一个 alias
,然后在 GitHub 仓库配置中引用此 pat_alias
。有关更多详细信息,请参阅“手动管理仓库 (config.local.json
)”部分。
config.local.json
中的示例 credentials
块如下:
{
"credentials": {
"github_pats": [
{
"alias": "my_lspace_pat",
"token": "ghp_YOUR_COPIED_GITHUB_TOKEN_HERE"
}
// 如果需要,你可以添加更多具有不同别名的 PAT
]
},
// ... 你的仓库配置的其余部分 ...
}
lspace-mcp-server.js
实现 Model Context Protocol (MCP),允许 AI 代理和其他工具以编程方式与 Lspace 功能进行交互。(有关 MCP 的更多信息,请参阅 modelcontextprotocol.io)。Lspace 使用双结构仓库架构:
/.lspace/raw_inputs/
):
/.lspace/timeline.json
中。README.md
)提供概述。除了快速开始部分,以下是更多配置细节:
config.local.json
)此文件对于定义仓库连接(本地路径、GitHub 仓库详细信息)和凭证(如 GitHub PATs)至关重要。有关其结构,请参阅“手动管理仓库 (config.local.json
)”部分。
指导大语言模型进行文档处理和知识库生成的提示集中在 src/config/prompts.ts
中。修改这些提示可自定义 AI 行为。
如果你除了 MCP 服务器之外还需要 RESTful API 端点(例如,用于 Web 应用程序集成或直接 HTTP 调用),或者想替代 MCP 服务器使用:
.env
和 config.local.json
已按上述说明设置。npm run build
npm run dev
npm start
这些脚本通常会启动 src/index.ts
中定义的完整应用程序,其中可能包括 REST API 和 MCP 功能。lspace-mcp-server.js
脚本是专门为仅进行 MCP 交互而优化的入口点。
config.local.json
)你可以通过直接编辑本地 config.local.json
文件来管理 Lspace 连接的仓库。此文件不会提交到版本控制(它包含在 .gitignore
中)。仓库中提供了一个示例模板 config.example.json
。
⚠️ 重要提示
请始终在
config.local.json
中进行更改。
文件的基本结构包括一个 credentials
列表(用于 GitHub 等服务)和一个 repositories
列表。
{
"credentials": {
"github_pats": [
{
"alias": "your_github_pat_alias",
"token": "ghp_yourgithubpersonalaccesstoken"
}
]
},
"repositories": [
{
"name": "My Local Project",
"type": "local",
"path": "/path/to/your/local/git/repository",
"path_to_kb": ".",
"id": "your_unique_id_for_this_repo"
},
{
"name": "My Awesome GitHub Project",
"type": "github",
"owner": "your-github-username-or-org",
"repo": "your-repository-name",
"branch": "main",
"pat_alias": "your_github_pat_alias",
"path_to_kb": ".",
"id": "another_unique_id"
}
]
}
config.local.json
的 repositories
数组中添加一个新对象(见上文示例)。
name
:一个人类可读的名称。type
:必须为 "local"
。path
:本地 Git 仓库的绝对路径。path_to_kb
(可选):仓库内知识库根目录的相对路径(例如,docs/kb
)。默认为 .
(仓库根目录)。id
(可选):一个唯一的 UUID。如果省略,将自动生成一个。repo
范围的 GitHub 个人访问令牌 (PAT)。credentials.github_pats
部分(见上文示例)。repositories
数组中添加一个新对象(见上文示例)。
name
、type
("github"
)、owner
、repo
、branch
、pat_alias
、path_to_kb
、id
如上述说明。编辑 config.local.json
后,重启 Lspace MCP 服务器或 API 服务器以使更改生效。Lspace 随后将尝试将新的 GitHub 仓库克隆到 REPO_BASE_PATH
指定的目录(或其默认的 cloned-github-repos
)中,并使所有配置的仓库可用。
本项目采用商业源许可证 1.1 (BSL 1.1) 授权。
这通常意味着:
有关完整的许可证文本,请参阅仓库中的 LICENSE
文件。