内容
# ODXProxy 中转服务器
TERRAKERNEL. PTE. LTD. 官方 ODXProxy 中转服务器.
## 概述
此软件包提供了一个模型上下文协议（MCP）服务器，用于连接 ODXProxy 与支持 MCP 的客户端/工具。它公开了以编程方式与 ODX/Odoo 资源交互的功能。
## 状态
早期版本（0.1.x）。随着 API 的不断演变，预计会有重大更改。
## 使用方法
请参阅 `src/index.ts` 和 `src/server.ts` 中的入口点。典型用法是在编译后从 `dist` 导入已构建的输出。
```ts
import {OdxInstanceInfo, OdxMCPServer,OdxProxyClientInfo} from "odxproxy-mcpserver";
import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
async function main() {
const env = process.env;
let clientInfo: OdxProxyClientInfo = {
instance: {
url: "ODOO 实例 URL",
user_id: 2,
db: "数据库名称",
api_key: "您的 ODOO API 密钥"
},
odx_api_key: "您的 ODXPROXY API 密钥",
gateway_url: "https://gateway.odxproxy.io"
};
let server = new OdxMCPServer(clientInfo);
await server.initBaseResource();
// 如果设置了 DRY_RUN，则初始化并退出，以允许在不挂起标准输入/输出的情况下进行烟雾测试。
if (env.DRY_RUN === "1") {
return;
}
let transport = new StdioServerTransport();
await server.connect(transport);
}
main().catch((error) => {
console.error(error);
});
```
您也可以在本地构建软件包并从源代码运行。
## 脚本
- build: 使用 tsup 构建 ESM/CJS 和类型声明
~~- test: 在 CI 模式下运行 Jest，并使用 JUnit 报告器~~
~~- test:watch: Jest 的监视模式~~
~~- prepublishOnly: 发布前构建和测试~~
运行：
```bash
npm run build
```
在成功构建软件包后，将编译后的输出嵌入到您的项目中，连接到任何支持的 LLM 客户端，如 Claude Desktop 或您自己的 MCP 客户端。访问 [https://modelcontextprotocol.io](https://modelcontextprotocol.io/docs/develop/connect-local-servers) 以获取有关连接到本地 MCP 服务器的更多信息。
## 开发
- 源代码：`src/`
- 资源：`res/`
- 编译产物：`dist/`
- TypeScript 配置：`tsconfig.json`
## 许可证
MIT 许可证 © 2025 TERRAKERNEL. PTE. LTD
请参阅 LICENSE 文件以获取全文。
## 作者
Julian Richie Wajong <julian.wajong@gmail.com>
## 链接
- 仓库：https://github.com/terrakernel/odxproxy-mcpserver
- 问题：https://github.com/terrakernel/odxproxy-mcpserver/issues
