安装

在五分钟内在本地启动服务器。

前提条件

  • Node.js 20 或更新版本 — nodejs.org。
  • Git — 用于克隆存储库。
  • npm — 随 Node.js 一起提供。

活跃的 SkySpark 实例是可选的,但一旦连接,可解锁执行、同步和实时查询功能。

克隆和构建

git clone https://github.com/Project-SandStar/AxonMcpServer.git
cd AxonMcpServer

# 安装依赖
npm install

# 将 TypeScript 编译为 JavaScript
npm run build

构建输出到 dist/。如果看到 TypeScript 错误,请使用 node --version 确认您的 Node 版本是 20+。

首次数据库初始化

管理员仪表板和用户存储通过 Prisma 持久化到 SQLite。运行初始迁移一次:

npx prisma migrate deploy

这将创建 .data/app.db 并植入初始管理员账户。默认凭证: admin / admin — 首次登录时立即更改密码。

启动服务器

Stdio 模式(适用于本地 MCP 客户端)

默认模式。AI 客户端(如 Claude Desktop)将服务器作为子进程生成,并通过 stdin/stdout 通信。

npm start

HTTP 模式(适用于远程 MCP 客户端 + 管理员仪表板)

MCP_TRANSPORT=http MCP_PORT=3847 npm start
  • MCP 端点:http://localhost:3847/mcp
  • 管理员仪表板:http://localhost:3847/admin
  • OAuth 端点:http://localhost:3847/oauth/*

将其连接到 MCP 客户端

对于 Claude Desktop,向 claude_desktop_config.json 添加一个块:

{
  "mcpServers": {
    "axon": {
      "command": "node",
      "args": ["/absolute/path/to/axon-mcp-server/dist/index.js"],
      "env": {
        "AXON_CONFIG": "/absolute/path/to/axon-config.json"
      }
    }
  }
}

重启客户端。axon 工具集应在工具选择器中出现。

验证其工作

服务器运行时,第一次 searchAxonExamples 调用触发初始代码 + 文档索引过程。首次预期需要 30–60 秒;随后的重启将在一秒内加载缓存索引。

如果看到 INDEX_NOT_FOUND 错误,请检查配置中的 codePath 和 docsPath 是否指向实际包含 .axon / .html 文件的目录。