Skip to main content
Glama
OA-MCP
by xuboboo
README.md
<div align="center">

# OA-MCP

<p align="center"><strong>Your OA data. Your agent. One connection.</strong><br />
Expose Weaver Ecology (泛微 OA) settlement data to any MCP-compatible agent.</p>

<p align="center">
<a href="README_CN.md">简体中文</a> · English<br />
<a href="#highlights">Highlights</a> · <a href="#quick-start">Quick Start</a> · <a href="#documentation">Documentation</a>
</p>

<p align="center">

[![MCP](https://img.shields.io/badge/MCP-2026--07--28-7C3AED)](https://modelcontextprotocol.io/)
![Node](https://img.shields.io/badge/node-%3E%3D24-brightgreen)
![TypeScript](https://img.shields.io/badge/TypeScript-5.9-3178C6)
![License](https://img.shields.io/badge/License-Proprietary-red)

</p>

</div>

---

## ✨ Highlights

> **OA-MCP = a read-only, semantic, multi-tenant MCP layer over Weaver Ecology settlement tables.**
>
> - **6 read-only tools** — no `execute_sql`; parameterized SQL only.
> - **Dual-era MCP** — 2026-07-28 modern and 2025 legacy stateless.
> - **Enterprise auth** — API Key (hashed) and optional OAuth 2.1 JWT.
> - **Safe by default** — PII redaction, untrusted-content labeling, audit, rate limit.
> - **Honest status** — `statusVerified:false` because workflow tables are not accessible.

## Overview

Weaver Ecology stores settlement data in MySQL with pinyin column names and no comments. OA-MCP adds a semantic, read-only, multi-tenant MCP layer so Codex / Claude Code / WorkBuddy / DeepSeek Harness can query it safely.

## Bring the agent you already use

| Agent | How to connect |
| --- | --- |
| WorkBuddy | Sidebar → Plugins → MCP Servers → Configure MCP |
| Codex CLI / IDE | `~/.codex/config.toml` |
| Claude Code | `.mcp.json` or `claude mcp add --transport http` |
| DeepSeek Harness | Cordis overlay YAML |
| Doubao / Qwen | See [CLIENTS.md](docs/CLIENTS.md) |

## Quick Start

### Let your agent install it

Send this to your agent:

```text
请按照 https://raw.githubusercontent.com/xuboboo/oa-mcp/main/AGENT_INSTALL.md 的说明,在本机为我配置并连接 OA-MCP(默认用本地 stdio 模式,不需要服务地址或 API Key)。如果我已经明确告诉你我有部署好的服务地址和密钥,才用远程模式。配置完确认工具可见并调用 list_datasets 验证。
```

<details><summary><b>Manual setup</b></summary>

```bash
git clone https://github.com/xuboboo/oa-mcp.git
cd oa-mcp
npm install
cp .env.example .env
npx tsx src/cli/index.ts doctor
npm run build && npm run start
```

</details>

### WorkBuddy one-line install

```text
请按照 https://raw.githubusercontent.com/xuboboo/oa-mcp/main/AGENT_INSTALL.md 的说明,在 WorkBuddy 中为本机配置并连接 OA-MCP(默认本地 stdio 模式,不需要服务地址或 API Key;只有我明确提供部署地址和密钥时才用远程模式),配置后用 list_datasets 验证。
```

### Try a task

```text
列出可用 OA 数据集,然后查询最近 2 条结算单,说明每条的结算金额与申请日期。
```

## Documentation

See the full [documentation index](docs/README.md) and the Chinese [README_CN.md](README_CN.md).

| Goal | Doc |
| --- | --- |
| Agent install | [AGENT_INSTALL.md](AGENT_INSTALL.md) |
| Full install + WorkBuddy | [INSTALLATION.md](docs/INSTALLATION.md) |
| Clients | [CLIENTS.md](docs/CLIENTS.md) |
| API | [API.md](docs/API.md) |
| Deployment | [DEPLOYMENT.md](docs/DEPLOYMENT.md) |
| Testing | [TESTING.md](docs/TESTING.md) |

## For developers

```bash
npm install && npm run typecheck && npm run test && npm run build
node scripts/stress50.mjs
```

See [ARCHITECTURE.md](docs/ARCHITECTURE.md) and [TECH-STACK.md](docs/TECH-STACK.md).

## License

Proprietary. See [LICENSE](LICENSE).