docs: 添加完整的项目 README 文件

README.md

@@ -0,0 +1,253 @@
+# kiro-rs
+
+一个用 Rust 编写的 Anthropic Claude API 兼容代理服务，将 Anthropic API 请求转换为 Kiro API 请求。
+
+## 功能特性
+
+- **Anthropic API 兼容**: 完整支持 Anthropic Claude API 格式
+- **流式响应**: 支持 SSE (Server-Sent Events) 流式输出
+- **Token 自动刷新**: 自动管理和刷新 OAuth Token
+- **Thinking 模式**: 支持 Claude 的 extended thinking 功能
+- **工具调用**: 完整支持 function calling / tool use
+- **多模型支持**: 支持 Sonnet、Opus、Haiku 系列模型
+
+## 支持的 API 端点
+
+| 端点 | 方法 | 描述          |
+|------|------|-------------|
+| `/v1/models` | GET | 获取可用模型列表    |
+| `/v1/messages` | POST | 创建消息（对话）    |
+| `/v1/messages/count_tokens` | POST | 估算 Token 数量 |
+
+## 快速开始
+
+### 1. 编译项目
+
+```bash
+cargo build --release
+```
+
+### 2. 配置文件
+
+创建 `config.json` 配置文件：
+
+```json
+{
+  "host": "127.0.0.1",
+  "port": 8990,
+  "apiKey": "sk-your-custom-api-key",
+  "region": "us-east-1",
+  "kiroVersion": "0.8.0",
+  "systemVersion": "darwin#24.6.0",
+  "nodeVersion": "22.21.1"
+}
+```
+
+### 3. 凭证文件
+
+创建 `credentials.json` 凭证文件（从 Kiro IDE 获取）：
+
+```json
+{
+  "accessToken": "your-access-token",
+  "refreshToken": "your-refresh-token",
+  "profileArn": "arn:aws:sso::123456789:profile/xxx",  // 登录时返回
+  "expiresAt": "2024-01-01T00:00:00Z",
+  "authMethod": "social",
+  "provider": "Google"
+}
+```
+
+### 4. 启动服务
+
+```bash
+./target/release/kiro-rs
+```
+
+或指定配置文件路径：
+
+```bash
+./target/release/kiro-rs -c /path/to/config.json --credentials /path/to/credentials.json
+```
+
+### 5. 使用 API
+
+```bash
+curl http://127.0.0.1:8990/v1/messages \
+  -H "Content-Type: application/json" \
+  -H "x-api-key: sk-your-custom-api-key" \
+  -d '{
+    "model": "claude-sonnet-4-20250514",
+    "max_tokens": 1024,
+    "messages": [
+      {"role": "user", "content": "Hello, Claude!"}
+    ]
+  }'
+```
+
+## 配置说明
+
+### config.json
+
+| 字段 | 类型 | 默认值 | 描述                      |
+|------|------|--------|-------------------------|
+| `host` | string | `127.0.0.1` | 服务监听地址                  |
+| `port` | number | `8080` | 服务监听端口                  |
+| `apiKey` | string | - | 自定义 API Key（用于客户端认证）    |
+| `region` | string | `us-east-1` | AWS 区域                  |
+| `kiroVersion` | string | `0.8.0` | Kiro 版本号                |
+| `machineId` | string | - | 自定义机器码（64位十六进制）不定义则自动生成 |
+| `systemVersion` | string | 随机 | 系统版本标识                  |
+| `nodeVersion` | string | `22.21.1` | Node.js 版本标识            |
+
+### credentials.json
+
+| 字段 | 类型 | 描述                      |
+|------|------|-------------------------|
+| `accessToken` | string | OAuth 访问令牌              |
+| `refreshToken` | string | OAuth 刷新令牌              |
+| `profileArn` | string | AWS Profile ARN (登录时返回) |
+| `expiresAt` | string | Token 过期时间 (RFC3339)    |
+| `authMethod` | string | 认证方式                    |
+| `provider` | string | 认证提供者                   |
+
+## 模型映射
+
+| Anthropic 模型 | Kiro 模型 |
+|----------------|-----------|
+| `*sonnet*` | `claude-sonnet-4.5` |
+| `*opus*` | `claude-opus-4.5` |
+| `*haiku*` | `claude-haiku-4.5` |
+
+## 项目结构
+
+```
+kiro-rs/
+├── src/
+│   ├── main.rs                 # 程序入口
+│   ├── model/                  # 配置和参数模型
+│   │   ├── config.rs           # 应用配置
+│   │   └── arg.rs              # 命令行参数
+│   ├── anthropic/              # Anthropic API 兼容层
+│   │   ├── router.rs           # 路由配置
+│   │   ├── handlers.rs         # 请求处理器
+│   │   ├── middleware.rs       # 认证中间件
+│   │   ├── types.rs            # 类型定义
+│   │   ├── converter.rs        # 协议转换器
+│   │   ├── stream.rs           # 流式响应处理
+│   │   └── token.rs            # Token 估算
+│   └── kiro/                   # Kiro API 客户端
+│       ├── provider.rs         # API 提供者
+│       ├── token_manager.rs    # Token 管理
+│       ├── machine_id.rs       # 设备指纹生成
+│       ├── model/              # 数据模型
+│       │   ├── credentials.rs  # OAuth 凭证
+│       │   ├── events/         # 响应事件类型
+│       │   ├── requests/       # 请求类型
+│       │   └── common/         # 共享类型
+│       └── parser/             # AWS Event Stream 解析器
+│           ├── decoder.rs      # 流式解码器
+│           ├── frame.rs        # 帧解析
+│           ├── header.rs       # 头部解析
+│           └── crc.rs          # CRC 校验
+├── Cargo.toml                  # 项目配置
+├── config.example.json         # 配置示例
+└── credentials.json            # 凭证文件
+```
+
+## 技术栈
+
+- **Web 框架**: [Axum](https://github.com/tokio-rs/axum) 0.8
+- **异步运行时**: [Tokio](https://tokio.rs/)
+- **HTTP 客户端**: [Reqwest](https://github.com/seanmonstar/reqwest)
+- **序列化**: [Serde](https://serde.rs/)
+- **日志**: [tracing](https://github.com/tokio-rs/tracing)
+- **命令行**: [Clap](https://github.com/clap-rs/clap)
+
+## 高级功能
+
+### Thinking 模式
+
+支持 Claude 的 extended thinking 功能：
+
+```json
+{
+  "model": "claude-sonnet-4-20250514",
+  "max_tokens": 16000,
+  "thinking": {
+    "type": "enabled",
+    "budget_tokens": 10000
+  },
+  "messages": [...]
+}
+```
+
+### 工具调用
+
+完整支持 Anthropic 的 tool use 功能：
+
+```json
+{
+  "model": "claude-sonnet-4-20250514",
+  "max_tokens": 1024,
+  "tools": [
+    {
+      "name": "get_weather",
+      "description": "获取指定城市的天气",
+      "input_schema": {
+        "type": "object",
+        "properties": {
+          "city": {"type": "string"}
+        },
+        "required": ["city"]
+      }
+    }
+  ],
+  "messages": [...]
+}
+```
+
+### 流式响应
+
+设置 `stream: true` 启用 SSE 流式响应：
+
+```json
+{
+  "model": "claude-sonnet-4-20250514",
+  "max_tokens": 1024,
+  "stream": true,
+  "messages": [...]
+}
+```
+
+## 认证方式
+
+支持两种 API Key 认证方式：
+
+1. **x-api-key Header**
+   ```
+   x-api-key: sk-your-api-key
+   ```
+
+2. **Authorization Bearer**
+   ```
+   Authorization: Bearer sk-your-api-key
+   ```
+
+## 环境变量
+
+可通过环境变量配置日志级别：
+
+```bash
+RUST_LOG=debug ./target/release/kiro-rs
+```
+
+## 注意事项
+
+1. **凭证安全**: 请妥善保管 `credentials.json` 文件，不要提交到版本控制
+2. **Token 刷新**: 服务会自动刷新过期的 Token，无需手动干预
+3. **不支持的工具**: `web_search` 和 `websearch` 工具会被自动过滤
+
+## License
+
+MIT