内容
<div align="center">
# EOS — GitHub 组织上下文 API
**适用于您整个 GitHub 组织的 AI 上下文层。**
将它指向您的组织，任何代理都理解它 — 谁拥有什么，如何组织代码，谁是相关人员，正在发生什么，以及工作流程如何 — 只需一次调用。
[](https://www.npmjs.com/package/@eos-ai/sdk)
[](https://www.npmjs.com/package/@eos-ai/mcp-server)
[](./LICENSE)
[文档](https://www.eos.dev/developers/api-reference) · [获取 API 密钥](https://www.eos.dev/settings/api) · [eos.dev](https://www.eos.dev)
</div>
---
每个 AI 代理、编码工具和内部工作流程都与其对组织的上下文信息质量相关。目前，每个工具都从原始的 GitHub REST/GraphQL API 中重建上下文信息，这可能会受到速率限制、数据不完整以及每次调用都需要重新构建的影响。
**GitHub 组织上下文 API** 是一个单一的端点，可以将整个组织转换为结构化的、适用于大型语言模型的上下文信息 — 包括所有权、依赖关系、专业知识、审查历史、架构和活动 — 通过 REST、官方 **MCP 服务器** 和 TypeScript/Python SDK 提供。无需爬取。无需速率限制。无需在内部重建相同的图谱。
## 快速入门
在 [eos.dev/settings/api](https://www.eos.dev/settings/api) 获取密钥，然后：
```bash
npm install @eos-ai/sdk
```
```ts
import { EosClient } from "@eos-ai/sdk";
const eos = new EosClient({ apiKey: process.env.EOS_API_KEY });
// 谁拥有这部分代码库？
const { data } = await eos.context.ownership({ repo: "acme/api", path: "src/auth" });
for (const owner of data) {
console.log(`${owner.handle} — ${owner.commits} commits`);
}
```
就这样 — 您已经在生产环境中使用组织的上下文信息了。
## 连接到 Claude / Cursor / 任意 MCP 客户端
添加官方 MCP 服务器，您的代理将获得组织的上下文信息，就像原生工具一样 — 无需额外代码：
```jsonc
{
"mcpServers": {
"eos": {
"command": "npx",
"args": ["-y", "@eos-ai/mcp-server"],
"env": { "EOS_API_KEY": "eos_your_key_here" }
}
}
}
```
## 上下文信息表面
| 表面 | 返回内容 |
|---|---|
| `context.ownership` | 谁拥有/了解文件、模块或系统 (+ bus-factor 信号) |
| `context.graph` | 模块/依赖关系图 — 仓库、模块、共同变更耦合 |
| `context.contributors` | 按人划分的专业知识和近期活动 |
| `context.pulls` | 进行中的 PR — 审查图、周转时间、谁在等待 |
| `context.search` | 自然语言检索 → LLM-ready 片段 **附带引用** |
| `context.activity` | 热点 — 变更集中在哪里 |
每个响应都是标准的 `{ data, meta }` 信封，无速率限制且预计算。列表按光标分页；SDK 的 `client.paginate()` 会为您处理分页。
## 本仓库包含的内容
| 软件包 | 描述 |
|---|---|
| [`packages/sdk`](./packages/sdk) — `@eos-ai/sdk` | 每个表面的类型化 TypeScript 客户端，带有重试 + 分页 |
| [`packages/mcp-server`](./packages/mcp-server) — `@eos-ai/mcp-server` | 官方模型上下文协议服务器 |
| [`packages/cli`](./packages/cli) — `@eos-ai/cli` | `eos` 命令行工具 |
| [`examples`](./examples) | 可运行的集成示例 |
Python SDK (`eos-context`) 即将推出。
## 为什么不直接调用 GitHub API？
GitHub 提供 **事件**；EOS 提供 **上下文** — 语义化、预计算、关系感知、无速率限制且适用于大型语言模型。它建模的是 **组织**（人员、所有权、依赖关系、流程），而不仅仅是代码文本，并且它是共享的、维护的层，而不是无差别的内部重建工作。编码助手不是竞争对手 — EOS 是 **底层** 的上下文层，使其代理更了解 **您的** 组织。
## 贡献
问题和 PR 欢迎 — 见 [CONTRIBUTING.md](./CONTRIBUTING.md) 和我们的 [行为准则](./CODE_OF_CONDUCT.md)。
## 许可证
[MIT](./LICENSE) © EOS
