mpd-llm-cli 0.1.24 → 0.1.28

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://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 2025 Google LLC
+
+   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
+
+       http://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.md

@@ -0,0 +1,203 @@
+![MPD LLM CLI Screenshot](./docs/assets/openrouter.png)
+
+<div align="center">
+
+<h4>  An open-source AI agent that is compatible with multiple LLM models（a forked version of Gemini CLI）.  </h4>
+
+[English](./README.md) | [简体中文](./README.zh-CN.md)
+
+</div>
+
+This repository contains the MPD LLM CLI（[Gemini Cli](https://github.com/google-gemini/gemini-cli) version of the Fork）, a command-line AI workflow tool that connects to your
+tools, understands your code and accelerates your workflows. It supports multiple LLM providers including Gemini, OpenAI, and any custom LLM API that follows OpenAI's API format.
+
+
+With the MPD LLM CLI you can:
+
+- Query and edit large codebases using advanced LLM capabilities with large context windows.
+- Generate new apps from PDFs or sketches, using multimodal capabilities.
+- Automate operational tasks, like querying pull requests or handling complex rebases.
+- Use tools and MCP servers to connect new capabilities.
+- Configure and use your preferred LLM provider through simple environment variables.
+- Seamlessly switch between different LLM providers without changing your workflow.
+
+<hr />
+
+This plan has conducted tests on various models from different providers as well as locally deployed models across multiple dimensions, including whether they have thinking chain, whether they can complete simple tasks, whether they have tool - calling capabilities, whether they have multimodal capabilities, whether they have complex task capabilities, and whether they can count tokens. The following are the test results:
+
+| Model | COT | Simple | Tool | MCP | Complex | Multimodal | Token |
+| --- | --- | --- | --- | --- | --- | --- | --- |
+| 【Rakuten AI Gateway】google/gemini-2.5-flash | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| 【Rakuten AI Gateway】claude-3-7-sonnet-20250219 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| 【Rakuten AI Gateway】Gpt-4.1 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| 【Rakuten AI Gateway】DeepSeek V3 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| 【Rakuten AI】DeepSeek V3| ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| 【Rakuten AI】DeepSeek R1| ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| 【Google】Gemini-2.5-pro | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| 【OpenRouter】Claude Sonnet 4 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| 【OpenRouter】Gpt-4.1 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| 【OpenRouter】Grok-4 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| 【Volcengine】Doubao-Seed-1.6 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| 【Bailian】Qwen3-Plus | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| 【Moonshot】kimi-k2 | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | ✅ |
+| 【Volcengine】DeepSeek-R1 | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | ✅ |
+| 【Siliconflow】DeepSeek-R1 | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | ✅ |
+| 【Volcengine】Doubao-1.5-Pro | ❌ | ✅ | ✅ | ✅ | ⚠️ | ❌ | ✅ |
+| 【Volcengine】DeepSeek-V3 | ❌ | ✅ | ✅ | ✅ | ⚠️ | ❌ | ✅ |
+| 【Bailian】Qwen3-235b-a22b | ✅ | ✅ | ✅ | ✅ | ⚠️ | ❌ | ✅ |
+| 【vLLM】Qwen2.5-7B-Instruct | ❌ | ✅ | ✅ | ✅ | ⚠️ | ❌ | ✅ |
+| 【vLLM】DeepSeek-R1-32B | ✅ | ✅ | ✅ | ✅ | ⚠️ | ❌ | ✅ |
+| 【Ollama】Qwen2.5-7B-Instruct | ❌ | ✅ | ✅ | ✅ | ⚠️ | ❌ | ✅ |
+
+## Quickstart
+
+1. **Prerequisites:** Ensure you have [Node.js version 20](https://nodejs.org/en/download) or higher installed.
+2. **Run the CLI:** Execute the following command in your terminal:
+
+   ```bash
+   npx mpd-llm-cli
+   ```
+
+   Or install it with:
+
+   ```bash
+   npm install -g mpd-llm-cli
+   mpdai
+   ```
+
+
+## Custom LLM Configuration
+
+MPD LLM CLI supports connecting to any OpenAI-compatible LLM API. You can configure your preferred LLM using these environment variables:
+
+```bash
+# Enable custom LLM support
+export USE_CUSTOM_LLM=true 
+
+export CUSTOM_LLM_PROVIDER="openai"  # LLM provider
+export CUSTOM_LLM_API_KEY="your-api-key"     # Your LLM provider API key
+export CUSTOM_LLM_ENDPOINT="https://api.your-llm-provider.com/v1"  # API endpoint e.g https://api.ai.public.rakuten-it.com/openai/v1
+export CUSTOM_LLM_MODEL_NAME="your-model-name"  # Model name e.g gpt-4.1
+
+# Optional parameters
+export CUSTOM_LLM_TEMPERATURE=0.7  # Temperature (default: 0)
+export CUSTOM_LLM_MAX_TOKENS=8192  # Max tokens (default: 8192)
+export CUSTOM_LLM_TOP_P=1          # Top P (default: 1)
+```
+
+When these variables are set, MPD LLM CLI will use your custom LLM instead of the default Gemini model.
+
+
+## Examples
+
+Once the CLI is running, you can start interacting with Gemini from your shell.
+
+You can start a project from a new directory:
+
+```sh
+cd new-project/
+mpdai
+> Write me a Discord bot that answers questions using a FAQ.md file I will provide
+```
+
+Or work with an existing project:
+
+```sh
+git clone https://git.rakuten-it.com/projects/MPD-AI/repos/mpd-llm-cli
+cd mpd-llm-cli
+mpdai
+> Give me a summary of all of the changes that went in yesterday
+```
+
+## Running in Code
+
+MPD LLM supports direct integration into your code via NPM:
+
+```javascript
+import { ElcAgent } from 'mpd-llm-cli';
+
+const agent = new ElcAgent({
+  model: 'custom-llm-model-name',
+  apiKey: 'custom-llm-api-key',
+  endpoint: 'custom-llm-endpoint',
+  extension: {
+    mcpServers: {
+      chart: {
+        command: 'npx',
+        args: ['-y', '@antv/mcp-server-chart'],
+        trust: false
+      }
+    },
+    excludeTools: ['run_shell_command']
+  }
+});
+
+const result = await agent.run('Please generate a bar chart for sales data');
+console.log(result);
+```
+
+- View detailed API documentation: [Programmatic API](./docs/programmatic-api.md)
+
+
+### Next steps
+
+- Learn how to [contribute to or build from the source](./CONTRIBUTING.md).
+- Explore the available **[CLI Commands](./docs/cli/commands.md)**.
+- If you encounter any issues, review the **[Troubleshooting guide](./docs/troubleshooting.md)**.
+- For more comprehensive documentation, see the [full documentation](./docs/index.md).
+- Take a look at some [popular tasks](#popular-tasks) for more inspiration.
+
+### Troubleshooting
+
+Head over to the [troubleshooting](docs/troubleshooting.md) guide if you're
+having issues.
+
+## Popular tasks
+
+### Explore a new codebase
+
+Start by `cd`ing into an existing or newly-cloned repository and running `elc`.
+
+```text
+> Describe the main pieces of this system's architecture.
+```
+
+```text
+> What security mechanisms are in place?
+```
+
+### Work with your existing code
+
+```text
+> Implement a first draft for GitHub issue #123.
+```
+
+```text
+> Help me migrate this codebase to the latest version of Java. Start with a plan.
+```
+
+### Automate your workflows
+
+Use MCP servers to integrate your local system tools with your enterprise collaboration suite.
+
+```text
+> Make me a slide deck showing the git history from the last 7 days, grouped by feature and team member.
+```
+
+```text
+> Make a full-screen web app for a wall display to show our most interacted-with GitHub issues.
+```
+
+### Interact with your system
+
+```text
+> Convert all the images in this directory to png, and rename them to use dates from the exif data.
+```
+
+```text
+> Organize my PDF invoices by month of expenditure.
+```
+
+```text
+>  test langfuse node test-langfuse.js
+```

package/README.zh-CN.md

@@ -0,0 +1,206 @@
+
+
+![MPD LLM CLI 截图](./docs/assets/openrouter.png)
+
+<div align="center">
+
+<h4> 一个与多种大语言模型（LLM）兼容的开源 AI Agent CLI（Gemini ClI 的 Fork 版本）。  </h4>
+
+[English](./README.md) | [简体中文](./README.zh-CN.md)
+
+</div>
+
+这个仓库包含了 MPD LLM CLI（[Gemini ClI](https://github.com/google-gemini/gemini-cli)  的 Fork 版本），一个连接到您的工具、理解您的代码并加速您工作流程的命令行 AI 工具。它支持多种 LLM 提供商，包括 Gemini、OpenAI 以及任何遵循 OpenAI API 格式的自定义 LLM API。
+
+使用 MPD LLM CLI，您可以：
+
+- 利用先进的 LLM 能力查询和编辑大型代码库，支持大上下文窗口
+- 使用多模态能力从 PDF 或草图生成新应用
+- 自动化操作任务，如查询 Pull Request 或处理复杂的 rebase 操作
+- 使用工具和 MCP 服务器连接新功能
+- 通过简单的环境变量配置和使用您首选的 LLM 提供商
+- 在不改变工作流程的情况下无缝切换不同的 LLM 提供商
+
+<hr />
+
+本方案已经对多种不同提供商、模型以及本地部署的模型进行了多个维度（是否具备思考过程、能否完成简单任务、是否具备工具调用能力、是否具备多模态能力、是否具备复杂任务能力、是否可以统计 Toekn）的测试，以下是测试结果：
+
+|  模型 | 思考过程 | 简单任务 | 工具调用 | MCP 调用 | 复杂任务 | 多模态 | Token 统计 |
+| --- | --- | --- | --- | --- | --- | --- | --- |
+| 【Rakuten AI Gateway】google/gemini-2.5-flash | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| 【Rakuten AI Gateway】claude-3-7-sonnet-20250219 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| 【Rakuten AI Gateway】Gpt-4.1 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| 【Rakuten AI Gateway】DeepSeek V3 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| 【Rakuten AI】DeepSeek V3| ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| 【Rakuten AI】DeepSeek R1| ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| 【Google】Gemini-2.5-pro | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| 【OpenRouter】Claude Sonnet 4 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| 【OpenRouter】Gpt-4.1 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| 【OpenRouter】Grok-4 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| 【Volcengine】Doubao-Seed-1.6 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| 【Bailian】Qwen3-Plus | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| 【Moonshot】kimi-k2 | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | ✅ |
+| 【Volcengine】DeepSeek-R1 | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | ✅ |
+| 【Siliconflow】DeepSeek-R1 | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | ✅ |
+| 【Volcengine】Doubao-1.5-Pro | ❌ | ✅ | ✅ | ✅ | ⚠️ | ❌ | ✅ |
+| 【Volcengine】DeepSeek-V3 | ❌ | ✅ | ✅ | ✅ | ⚠️ | ❌ | ✅ |
+| 【Bailian】Qwen3-235b-a22b | ✅ | ✅ | ✅ | ✅ | ⚠️ | ❌ | ✅ |
+| 【vLLM】Qwen2.5-7B-Instruct | ❌ | ✅ | ✅ | ✅ | ⚠️ | ❌ | ✅ |
+| 【vLLM】DeepSeek-R1--32B | ✅ | ✅ | ✅ | ✅ | ⚠️ | ❌ | ✅ |
+| 【Ollama】Qwen2.5-7B-Instruct | ❌ | ✅ | ✅ | ✅ | ⚠️ | ❌ | ✅ |
+
+## 快速开始
+
+1. **前提条件：** 确保您安装了 [Node.js 20 版本](https://nodejs.org/en/download) 或更高版本。
+2. **运行 CLI：** 在您的终端中执行以下命令：
+
+```bash
+   npx mpd-llm-cli
+```
+
+或者使用以下命令安装：
+
+```bash
+   npm install -g mpd-llm-cli
+   mpdai
+```
+
+```bash
+## 在项目目录中安装依赖
+##创建全局链接，这样你就可以在任何地方使用 mpdai 命令
+npm install
+
+
+npm link
+```
+
+## 自定义 LLM 配置
+
+MPD LLM 命令行工具支持连接到任何兼容 OpenAI 的 LLM API。你可以使用以下环境变量配置首选的 LLM：
+
+```bash
+# 启用自定义 LLM 支持
+export USE_CUSTOM_LLM=true
+export CUSTOM_LLM_API_KEY="your-api-key"     # 你的 LLM 提供商 API 密钥
+export CUSTOM_LLM_ENDPOINT="https://api.your-llm-provider.com/v1"  # API 端点  e.g https://api.ai.public.rakuten-it.com/openai/v1
+export CUSTOM_LLM_MODEL_NAME="your-model-name"  # 模型名称  e.g gpt-4.1
+
+# 可选参数
+export CUSTOM_LLM_TEMPERATURE=0.7  # 温度参数（默认值：0）
+export CUSTOM_LLM_MAX_TOKENS=8192  # 最大令牌数（默认值：8192）
+export CUSTOM_LLM_TOP_P=1          # Top P 参数（默认值：1）
+```
+
+当这些变量设置后，MPD LLM 命令行工具将使用你的自定义 LLM，而非默认的 Gemini 模型。
+
+
+## 示例
+
+一旦 CLI 运行起来，你就可以从 shell 中与 Gemini 交互了。
+
+你可以从新目录开始一个项目：
+
+```sh
+cd new-project/
+mpdai
+> 帮我写一个 Discord 机器人，它能使用我将要提供的 FAQ.md 文件来回答问题
+```
+
+或者处理一个已有的项目：
+
+```sh
+git clone https://git.rakuten-it.com/projects/MPD-AI/repos/mpd-llm-cli
+cd mpd-llm-cli
+mpdai
+> 给我总结一下昨天所有的变更内容
+```
+
+## 在代码中运行
+
+MPD LLM 支持直接在代码中通过 NPM 引入并使用：
+
+```js
+  import { ElcAgent } from 'mpd-llm-cli';
+  const agent = new ElcAgent({
+    model: 'custom-llm-model-name',
+    apiKey: 'custom-llm-api-key',
+    endpoint: 'custom-llm-endpoint',
+    extension: {
+      mcpServers: {
+        chart: {
+          command: 'npx',
+          args: ['-y', '@antv/mcp-server-chart'],
+          trust: false
+        }
+      },
+      excludeTools: ['run_shell_command']
+    }
+  });
+  const result = await agent.run('请帮我生成一个销售数据的柱状图');
+  console.log(result);
+```
+
+- 查看 API 调用详细文档：[Programmatic API](./docs/programmatic-api.zh-CN.md)
+
+### 后续步骤
+
+- 了解如何[贡献代码或从源码构建](./CONTRIBUTING.md)。
+- 探索可用的**[CLI 命令](./docs/cli/commands.md)**。
+- 如果遇到任何问题，请查看**[故障排除指南](./docs/troubleshooting.md)**。
+- 如需更全面的文档，请参阅[完整文档](./docs/index.md)。
+- 查看一些[热门任务](#热门任务)获取更多灵感。
+
+### 故障排除
+
+如果遇到问题，请查看[故障排除](docs/troubleshooting.md)指南。
+
+## 热门任务
+
+### 探索新代码库
+
+首先进入一个已有的或新克隆的仓库，然后运行 `mpdai`。
+
+```text
+> 描述这个系统架构的主要组成部分。
+```
+
+```text
+> 有哪些安全机制在运行？
+```
+
+### 处理现有代码
+
+```text
+> 为 GitHub 第 123 号 issue 实现初稿。
+```
+
+```text
+> 帮我把这个代码库迁移到最新版本的 Java。先制定一个计划。
+```
+
+### 自动化工作流
+
+使用 MCP 服务器将本地系统工具与企业协作套件集成。
+
+```text
+> 制作一个幻灯片，展示过去 7 天的 git 历史，按功能和团队成员分组。
+```
+
+```text
+> 制作一个全屏网页应用，用于墙上显示器，展示我们互动最多的 GitHub 问题。
+```
+
+### 与系统交互
+
+```text
+> 将此目录中的所有图像转换为 png 格式，并根据 exif 数据中的日期重命名。
+```
+
+```text
+> 按支出月份整理我的 PDF 发票。
+```
+
+```text
+> 测试langfuse
+ node test-langfuse.js
+```