scythe-context-mcp 0.1.0

package/.env.example

@@ -0,0 +1,21 @@
+GEMINI_API_KEY=
+GEMINI_BASE_URL=https://generativelanguage.googleapis.com/v1beta
+GEMINI_MODEL=gemini-embedding-2
+GEMINI_OUTPUT_DIMENSIONALITY=1536
+
+# Third-party proxy compatibility:
+# x-goog-api-key | bearer | query
+GEMINI_AUTH_MODE=x-goog-api-key
+GEMINI_API_KEY_HEADER=x-goog-api-key
+GEMINI_API_KEY_QUERY_PARAM=key
+
+SCYTHE_CONTEXT_DEFAULT_PROJECT=
+SCYTHE_CONTEXT_INDEX_DIR=.scythe-context
+SCYTHE_CONTEXT_MAX_FILE_BYTES=524288
+SCYTHE_CONTEXT_TARGET_CHUNK_CHARS=4000
+SCYTHE_CONTEXT_CHUNK_OVERLAP_CHARS=400
+SCYTHE_CONTEXT_MAX_CHUNKS_PER_FILE=80
+SCYTHE_CONTEXT_EMBEDDING_BATCH_SIZE=16
+SCYTHE_CONTEXT_MAX_EMBEDDING_CHUNKS=256
+
+# Legacy REPO_BEACON_* variables are still accepted as fallback during migration.

package/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+This project follows semantic versioning before npm publication where practical.
+
+## [0.1.0] - 2026-06-13
+
+### Added
+
+- Local stdio MCP server for Codex App / CLI.
+- Gemini Embedding 2 provider with official Gemini and v1beta proxy compatibility.
+- Configurable auth modes: `x-goog-api-key`, `bearer`, and `query`.
+- SQLite metadata store, SQLite FTS5 keyword index, and sqlite-vec vector index.
+- File scanner, chunker, persistent metadata indexing, and embedding cache.
+- Semantic, keyword, and hybrid search.
+- Lightweight symbol/dependency graph with related-file lookup.
+- `repo_context_pack` with context budgeting, bounded multi-hop traversal, and optional related snippets.
+- `repo_index_status` metadata, embedding, and freshness diagnostics.
+- `gemini_embedding_probe` provider diagnostics with secret-safe errors.
+- Multilingual README files: Traditional Chinese, English, and Simplified Chinese.
+- GitHub CI, issue templates, PR template, security policy, contributing guide, and Apache-2.0 license.
+
+### Notes
+
+- Embedding text is sent to the configured Gemini-compatible endpoint only when embedding operations are requested.
+- Local indexes are stored under `.scythe-context/` by default and are not committed.

package/LICENSE

@@ -0,0 +1,201 @@
+Apache License
+Version 2.0, January 2004
+https://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the purposes
+of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including
+the original version of the Work and any modifications or additions
+to that Work or Derivative Works thereof, that is intentionally
+submitted to Licensor for inclusion in the Work by the copyright owner
+or by an individual or Legal Entity authorized to submit on behalf of
+the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the
+Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made,
+use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable
+by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You
+institute patent litigation against any entity (including a cross-claim
+or counterclaim in a lawsuit) alleging that the Work or a Contribution
+incorporated within the Work constitutes direct or contributory patent
+infringement, then any patent licenses granted to You under this
+License for that Work shall terminate as of the date such litigation
+is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You
+meet the following conditions:
+
+(a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+You may add Your own copyright statement to Your modifications and
+may provide additional or different license terms and conditions
+for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with
+the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work
+by You to the Licensor shall be under the terms and conditions of
+this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed
+with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise,
+unless required by applicable law (such as deliberate and grossly
+negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+the Work or Derivative Works thereof, You may choose to offer,
+and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf
+of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason
+of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following
+boilerplate notice, with the fields enclosed by brackets "[]"
+replaced with your own identifying information. (Don't include
+the brackets!) The text should be enclosed in the appropriate
+comment syntax for the file format. We also recommend that a
+file or class name and description of purpose be included on the
+same "printed page" as the copyright notice for easier
+identification within third-party archives.
+
+Copyright 2026 scythe-context-mcp contributors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    https://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.en.md

@@ -0,0 +1,197 @@
+# Scythe Context MCP
+
+[![CI](https://github.com/Lianye-Scythe/scythe-context-mcp/actions/workflows/ci.yml/badge.svg)](https://github.com/Lianye-Scythe/scythe-context-mcp/actions/workflows/ci.yml)
+[![License: Apache-2.0](https://img.shields.io/badge/License-Apache--2.0-blue.svg)](LICENSE)
+[![Node.js >=24.11](https://img.shields.io/badge/Node.js-%3E%3D24.11-339933.svg)](package.json)
+
+[繁體中文](README.md) | [English](README.en.md) | [简体中文](README.zh-CN.md)
+
+Scythe Context MCP is a local code-context engine for Codex App / Codex CLI. It builds a SQLite/sqlite-vec index inside the repo and combines semantic search, keyword search, symbol/dependency metadata, and context packing so Codex can retrieve actionable files, line ranges, snippets, and related paths faster.
+
+## Why Use It
+
+- **Local-first**: metadata, FTS, and vector indexes live under `.scythe-context/`.
+- **Hybrid retrieval**: combines Gemini embeddings, SQLite FTS5, path boosts, and symbol-aware ranking instead of relying on one retrieval path.
+- **Codex-oriented output**: returns line ranges, snippets, match reasons, grep keywords, related files, and suggested paths.
+- **Bring your own provider**: supports the official Gemini API and third-party Gemini-compatible v1beta proxies.
+- **Diagnosable**: includes provider probe, index freshness, embedding coverage, and actionable remediation hints.
+
+Privacy note: query or chunk text is sent to the configured Gemini-compatible endpoint only when embedding features are used. Treat third-party proxies as services that can see that text.
+
+## Feature Status
+
+Implemented:
+
+- repo scanning, binary/large-file skipping, and chunking
+- SQLite metadata, SQLite FTS5, and sqlite-vec vector indexes
+- Gemini Embedding 2 provider and batch fallback
+- semantic / keyword / hybrid search
+- lightweight symbol/dependency graph
+- related-file lookup and bounded multi-hop traversal
+- `repo_context_pack` context budgeting and related snippet packing
+- provider diagnostics and index freshness diagnostics
+
+Next:
+
+- provider capability cache
+- fuller install/native dependency doctor
+- keyword-only fallback when embeddings fail
+- tree-sitter symbol extraction if needed
+
+## Installation
+
+### From npm
+
+Install the CLI globally from npm:
+
+```bash
+npm install -g scythe-context-mcp
+```
+
+### From source
+
+```bash
+git clone https://github.com/Lianye-Scythe/scythe-context-mcp.git
+cd scythe-context-mcp
+npm install
+cp .env.example .env
+npm run build
+```
+
+Runtime target: Node.js 24 LTS. Node 26 may work, but it is not the baseline until it enters LTS.
+
+The old project name `repo-beacon-mcp` has been renamed to `scythe-context-mcp`. Legacy `REPO_BEACON_*` environment variables are still accepted as fallback, but new setups should use `SCYTHE_CONTEXT_*`.
+
+## Codex Setup
+
+### npm binary
+
+If installed globally from npm:
+
+```toml
+[mcp_servers.scythe_context]
+command = "scythe-context-mcp"
+enabled = true
+required = false
+startup_timeout_sec = 20
+tool_timeout_sec = 120
+env_vars = ["GEMINI_API_KEY"]
+enabled_tools = [
+  "repo_index_status",
+  "repo_reindex",
+  "repo_context_pack",
+  "repo_semantic_search",
+  "repo_related_files",
+  "gemini_embedding_probe"
+]
+
+[mcp_servers.scythe_context.env]
+GEMINI_OUTPUT_DIMENSIONALITY = "1536"
+```
+
+### Local checkout
+
+If running from source:
+
+```toml
+[mcp_servers.scythe_context]
+command = "node"
+args = ["/path/to/scythe-context-mcp/dist/index.js"]
+cwd = "/path/to/scythe-context-mcp"
+enabled = true
+required = false
+startup_timeout_sec = 20
+tool_timeout_sec = 120
+env_vars = ["GEMINI_API_KEY"]
+
+[mcp_servers.scythe_context.env]
+GEMINI_OUTPUT_DIMENSIONALITY = "1536"
+```
+
+### Third-party v1beta proxy
+
+```toml
+[mcp_servers.scythe_context.env]
+GEMINI_BASE_URL = "https://your-proxy.example.com/v1beta"
+GEMINI_AUTH_MODE = "bearer"
+GEMINI_OUTPUT_DIMENSIONALITY = "1536"
+```
+
+Supported auth modes:
+
+- `x-goog-api-key`
+- `bearer`
+- `query`
+
+Set `GEMINI_API_KEY` in the shell or system environment before starting Codex. Do not write API keys into synced or committed config files.
+
+## Typical Workflow
+
+1. Check index status first:
+
+   ```text
+   repo_index_status
+   ```
+
+2. If metadata is missing or freshness is stale:
+
+   ```text
+   repo_reindex({ "dry_run": false })
+   ```
+
+3. Build embeddings only when semantic search or context packs need vectors:
+
+   ```text
+   repo_reindex({ "dry_run": false, "index_embeddings": true })
+   ```
+
+4. Ask Codex for task-oriented context:
+
+   ```text
+   repo_context_pack({ "query": "where is auth token validation handled?" })
+   ```
+
+5. Expand imports / reverse imports for a matched file:
+
+   ```text
+   repo_related_files({ "path": "src/server/auth.ts" })
+   ```
+
+## MCP Tools
+
+| Tool | Purpose |
+| --- | --- |
+| `repo_index_status` | Shows index path, metadata/embedding coverage, freshness diagnostics, and recommended actions. |
+| `repo_reindex` | Scans the project and writes metadata; calls the embedding provider only when `index_embeddings=true`. |
+| `repo_context_pack` | Packs primary snippets, match reasons, related files, and suggested paths for a task query. |
+| `repo_semantic_search` | Runs hybrid or semantic search over indexed chunks; useful for ranking diagnostics. |
+| `repo_related_files` | Shows symbols, imports, and importedBy for one file. |
+| `gemini_embedding_probe` | Tests Gemini or proxy compatibility and returns endpoint, latency, error classification, and remediation hints. |
+
+## Privacy and Local Files
+
+- `.scythe-context/`: default index directory, not committed.
+- `.repo-beacon/`: legacy index directory name, still ignored.
+- `local/`: private API test files, reference HTML, screenshots, and other local-only material.
+- `.env`: local configuration, not committed.
+
+Do not include API keys, proxy tokens, private source snippets, or index databases in issues, PRs, or public logs.
+
+## Documentation
+
+- [Architecture](docs/architecture.md)
+- [Development Plan](docs/development-plan.md)
+- [Gemini Compatibility](docs/gemini-compatibility.md)
+- [Tech Stack](docs/tech-stack.md)
+- [Codex Integration Review](docs/codex-integration.md)
+
+## Development and Publishing Checks
+
+```bash
+npm test
+npm run build
+npm audit --omit=dev
+npm pack --dry-run
+```
+
+Confirm the package does not include `.env`, `.scythe-context/`, `.repo-beacon/`, `local/`, API keys, or private reference files.

package/README.md

@@ -0,0 +1,197 @@
+# Scythe Context MCP
+
+[![CI](https://github.com/Lianye-Scythe/scythe-context-mcp/actions/workflows/ci.yml/badge.svg)](https://github.com/Lianye-Scythe/scythe-context-mcp/actions/workflows/ci.yml)
+[![License: Apache-2.0](https://img.shields.io/badge/License-Apache--2.0-blue.svg)](LICENSE)
+[![Node.js >=24.11](https://img.shields.io/badge/Node.js-%3E%3D24.11-339933.svg)](package.json)
+
+[繁體中文](README.md) | [English](README.en.md) | [简体中文](README.zh-CN.md)
+
+Scythe Context MCP 是給 Codex App / Codex CLI 使用的本機程式碼上下文引擎。它在 repo 內建立 SQLite/sqlite-vec 索引，結合語義搜尋、關鍵字搜尋、符號/依賴關係與 context packing，讓 Codex 更快拿到可操作的檔案、行號、片段與相關路徑。
+
+## 為什麼用它
+
+- **本機優先**：metadata、FTS 與向量索引都存在 repo 內的 `.scythe-context/`。
+- **混合搜尋**：結合 Gemini embeddings、SQLite FTS5、path/symbol ranking，避免只靠單一召回方式。
+- **Codex 友善輸出**：回傳 line ranges、snippets、match reasons、grep keywords、related files 與 suggested paths。
+- **可接自己的 provider**：支援官方 Gemini API，也支援第三方 Gemini-compatible v1beta proxy。
+- **可診斷**：內建 provider probe、index freshness、embedding coverage 與可修復建議。
+
+隱私提醒：只有在執行 embedding 相關功能時，query 或 chunk text 才會送到你設定的 Gemini-compatible endpoint。第三方 proxy 應視為可看到這些文字。
+
+## 功能狀態
+
+已完成：
+
+- repo 掃描、binary/large-file skip、chunking
+- SQLite metadata、SQLite FTS5、sqlite-vec 向量索引
+- Gemini Embedding 2 provider 與 batch fallback
+- semantic / keyword / hybrid search
+- 輕量 symbol/dependency graph
+- related-file lookup、bounded multi-hop traversal
+- `repo_context_pack` context budgeting 與 related snippet packing
+- provider diagnostics 與 index freshness diagnostics
+
+下一步：
+
+- provider capability cache
+- 更完整的安裝/原生依賴 doctor
+- embedding 失敗時的 keyword-only fallback
+- 必要時加入 tree-sitter symbol extraction
+
+## 安裝
+
+### 從 npm 安裝
+
+使用 npm 安裝全域指令：
+
+```bash
+npm install -g scythe-context-mcp
+```
+
+### 從原始碼安裝
+
+```bash
+git clone https://github.com/Lianye-Scythe/scythe-context-mcp.git
+cd scythe-context-mcp
+npm install
+cp .env.example .env
+npm run build
+```
+
+Runtime 目標是 Node.js 24 LTS。Node 26 可能可用，但在進入 LTS 前不作為主要驗收基準。
+
+舊專案名 `repo-beacon-mcp` 已改為 `scythe-context-mcp`。舊的 `REPO_BEACON_*` 環境變數仍作為 fallback 相容，但新設定應改用 `SCYTHE_CONTEXT_*`。
+
+## Codex 設定
+
+### npm binary
+
+如果已用 npm 全域安裝：
+
+```toml
+[mcp_servers.scythe_context]
+command = "scythe-context-mcp"
+enabled = true
+required = false
+startup_timeout_sec = 20
+tool_timeout_sec = 120
+env_vars = ["GEMINI_API_KEY"]
+enabled_tools = [
+  "repo_index_status",
+  "repo_reindex",
+  "repo_context_pack",
+  "repo_semantic_search",
+  "repo_related_files",
+  "gemini_embedding_probe"
+]
+
+[mcp_servers.scythe_context.env]
+GEMINI_OUTPUT_DIMENSIONALITY = "1536"
+```
+
+### 本機 checkout
+
+如果從原始碼執行：
+
+```toml
+[mcp_servers.scythe_context]
+command = "node"
+args = ["/path/to/scythe-context-mcp/dist/index.js"]
+cwd = "/path/to/scythe-context-mcp"
+enabled = true
+required = false
+startup_timeout_sec = 20
+tool_timeout_sec = 120
+env_vars = ["GEMINI_API_KEY"]
+
+[mcp_servers.scythe_context.env]
+GEMINI_OUTPUT_DIMENSIONALITY = "1536"
+```
+
+### 第三方 v1beta proxy
+
+```toml
+[mcp_servers.scythe_context.env]
+GEMINI_BASE_URL = "https://your-proxy.example.com/v1beta"
+GEMINI_AUTH_MODE = "bearer"
+GEMINI_OUTPUT_DIMENSIONALITY = "1536"
+```
+
+支援的 auth mode：
+
+- `x-goog-api-key`
+- `bearer`
+- `query`
+
+啟動 Codex 前在 shell 或系統環境中設定 `GEMINI_API_KEY`，避免把 key 寫進可同步或可提交的設定檔。
+
+## 常用工作流
+
+1. 先檢查索引狀態：
+
+   ```text
+   repo_index_status
+   ```
+
+2. 如果 metadata 不存在或 freshness 顯示 stale：
+
+   ```text
+   repo_reindex({ "dry_run": false })
+   ```
+
+3. 需要語義搜尋或 context pack 時，再建立 embeddings：
+
+   ```text
+   repo_reindex({ "dry_run": false, "index_embeddings": true })
+   ```
+
+4. 讓 Codex 針對任務拿上下文：
+
+   ```text
+   repo_context_pack({ "query": "where is auth token validation handled?" })
+   ```
+
+5. 對某個命中檔案展開 imports / reverse imports：
+
+   ```text
+   repo_related_files({ "path": "src/server/auth.ts" })
+   ```
+
+## MCP 工具
+
+| Tool | 用途 |
+| --- | --- |
+| `repo_index_status` | 查看 index path、metadata/embedding coverage、freshness diagnostics 與建議動作。 |
+| `repo_reindex` | 掃描專案並寫入 metadata；設定 `index_embeddings=true` 時才會呼叫 embedding provider。 |
+| `repo_context_pack` | 針對任務查詢打包 primary snippets、match reasons、related files 與 suggested paths。 |
+| `repo_semantic_search` | 對已索引 chunks 做 hybrid 或 semantic search，適合排查 ranking。 |
+| `repo_related_files` | 查看單一檔案的 symbols、imports、importedBy。 |
+| `gemini_embedding_probe` | 測試 Gemini 或 proxy 相容性，回傳 endpoint、latency、錯誤分類與可修復建議。 |
+
+## 隱私與本機檔案
+
+- `.scythe-context/`: 預設索引目錄，不提交。
+- `.repo-beacon/`: 舊索引目錄名稱，仍被 ignore。
+- `local/`: 私密 API 測試檔、參考 HTML、截圖等本機資料，不提交。
+- `.env`: 本機設定，不提交。
+
+不要把 API key、proxy token、私有程式碼片段或 index database 放進 issue、PR 或公開 logs。
+
+## 文件
+
+- [架構設計](docs/architecture.md)
+- [開發計畫](docs/development-plan.md)
+- [Gemini 相容性](docs/gemini-compatibility.md)
+- [技術棧](docs/tech-stack.md)
+- [Codex 整合審查](docs/codex-integration.md)
+
+## 開發與發佈檢查
+
+```bash
+npm test
+npm run build
+npm audit --omit=dev
+npm pack --dry-run
+```
+
+確認 package 不包含 `.env`、`.scythe-context/`, `.repo-beacon/`, `local/`, API key 或私密參考檔。