安装

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

前置条件

  • Node.js 18 或更新版本nodejs.org
  • Git — 用于克隆仓库。
  • npm — 随 Node.js 附带。

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

克隆和构建

git clone https://github.com/Project-SandStar/axon-mcp-server.git
cd axon-mcp-server

# 安装依赖
npm install

# 将 TypeScript 编译为 JavaScript
npm run build

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

首次数据库初始化

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

npx prisma migrate deploy

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

启动服务器

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

默认模式。Claude Desktop 等 AI 客户端会将服务器作为子进程生成,并通过 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 秒;后续重启将在 1 秒内加载缓存的索引。

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