tools.mdx 8.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341
  1. ---
  2. title: Narzędzia
  3. description: Zarządzaj narzędziami, z których może korzystać LLM.
  4. ---
  5. Narzędzia umożliwiają LLM wykonywanie działań w bazie kodu. OpenCode posiada zestaw wbudowanych narzędzi, ale możesz go rozszerzyć o [narzędzia niestandardowe](/docs/custom-tools) lub [serwery MCP](/docs/mcp-servers).
  6. Domyślnie wszystkie narzędzia są **włączone** i nie wymagają zatwierdzenia przed uruchomieniem. Możesz kontrolować zachowanie narzędzi poprzez [uprawnienia](/docs/permissions).
  7. ---
  8. ## Konfiguracja
  9. Użyj pola `permission` do kontrolowania zachowania narzędzia. Dla każdego narzędzia możesz zezwolić (`allow`), odmówić (`deny`) lub wymagać zatwierdzenia (`ask`).
  10. ```json title="opencode.json"
  11. {
  12. "$schema": "https://opencode.ai/config.json",
  13. "permission": {
  14. "edit": "deny",
  15. "bash": "ask",
  16. "webfetch": "allow"
  17. }
  18. }
  19. ```
  20. Możesz także używać symboli wieloznacznych do kontrolowania wielu narzędzi jednocześnie. Na przykład, aby wymagać zatwierdzenia dla wszystkich narzędzi z serwera MCP:
  21. ```json title="opencode.json"
  22. {
  23. "$schema": "https://opencode.ai/config.json",
  24. "permission": {
  25. "mymcp_*": "ask"
  26. }
  27. }
  28. ```
  29. [Dowiedz się więcej](/docs/permissions) o konfigurowaniu uprawnień.
  30. ---
  31. ## Wbudowane narzędzia
  32. Oto wszystkie wbudowane narzędzia dostępne w OpenCode.
  33. ---
  34. ### bash
  35. Wykonuj polecenia powłoki (shell) w środowisku projektu.
  36. ```json title="opencode.json" {4}
  37. {
  38. "$schema": "https://opencode.ai/config.json",
  39. "permission": {
  40. "bash": "allow"
  41. }
  42. }
  43. ```
  44. To narzędzie umożliwia LLM uruchamianie poleceń terminalowych, takich jak `npm install`, `git status` lub dowolne inne polecenie powłoki.
  45. ---
  46. ### edit
  47. Modyfikuj istniejące pliki poprzez precyzyjne zastępowanie tekstu.
  48. ```json title="opencode.json" {4}
  49. {
  50. "$schema": "https://opencode.ai/config.json",
  51. "permission": {
  52. "edit": "allow"
  53. }
  54. }
  55. ```
  56. To narzędzie umożliwia precyzyjną edycję plików poprzez zastąpienie dokładnych dopasowań tekstu. Jest to główny sposób, w jaki LLM modyfikuje kod.
  57. ---
  58. ### write
  59. Twórz nowe pliki lub nadpisuj istniejące.
  60. ```json title="opencode.json" {4}
  61. {
  62. "$schema": "https://opencode.ai/config.json",
  63. "permission": {
  64. "edit": "allow"
  65. }
  66. }
  67. ```
  68. Użyj tego, aby umożliwić LLM tworzenie nowych plików. Zastąpi istniejące pliki, jeśli już istnieją.
  69. :::note
  70. Narzędzie `write` jest kontrolowane przez uprawnienie `edit`, które obejmuje wszystkie modyfikacje plików (`edit`, `write`, `patch`).
  71. :::
  72. ---
  73. ### read
  74. Odczytaj zawartość pliku z bazy kodu.
  75. ```json title="opencode.json" {4}
  76. {
  77. "$schema": "https://opencode.ai/config.json",
  78. "permission": {
  79. "read": "allow"
  80. }
  81. }
  82. ```
  83. Narzędzie to odczytuje pliki i zwraca ich zawartość. Obsługuje czytanie określonych zakresów linii w przypadku dużych plików.
  84. ---
  85. ### grep
  86. Przeszukuj zawartość plików za pomocą wyrażeń regularnych.
  87. ```json title="opencode.json" {4}
  88. {
  89. "$schema": "https://opencode.ai/config.json",
  90. "permission": {
  91. "grep": "allow"
  92. }
  93. }
  94. ```
  95. Szybkie wyszukiwanie treści w całej bazie kodu. Obsługuje pełną składnię wyrażeń regularnych i filtrowanie wzorców plików.
  96. ---
  97. ### glob
  98. Znajduj pliki na podstawie wzorców.
  99. ```json title="opencode.json" {4}
  100. {
  101. "$schema": "https://opencode.ai/config.json",
  102. "permission": {
  103. "glob": "allow"
  104. }
  105. }
  106. ```
  107. Szukaj plików przy użyciu wzorców glob, takich jak `**/*.js` lub `src/**/*.ts`. Zwraca pasujące ścieżki plików posortowane według czasu modyfikacji.
  108. ---
  109. ### LSP (eksperymentalne)
  110. Interakcja ze skonfigurowanymi serwerami LSP w celu uzyskania funkcji analizy kodu, takich jak definicje, referencje, podpowiedzi (hover) i hierarchia wywołań.
  111. :::note
  112. To narzędzie jest dostępne tylko wtedy, gdy `OPENCODE_EXPERIMENTAL_LSP_TOOL=true` (lub `OPENCODE_EXPERIMENTAL=true`).
  113. :::
  114. ```json title="opencode.json" {4}
  115. {
  116. "$schema": "https://opencode.ai/config.json",
  117. "permission": {
  118. "lsp": "allow"
  119. }
  120. }
  121. ```
  122. Obsługiwane operacje obejmują `goToDefinition`, `findReferences`, `hover`, `documentSymbol`, `workspaceSymbol`, `goToImplementation`, `prepareCallHierarchy`, `incomingCalls` i `outgoingCalls`.
  123. Aby skonfigurować, które serwery LSP są dostępne dla Twojego projektu, zobacz [Serwery LSP](/docs/lsp).
  124. ---
  125. ### patch
  126. Stosuj łatki (patches) do plików.
  127. ```json title="opencode.json" {4}
  128. {
  129. "$schema": "https://opencode.ai/config.json",
  130. "permission": {
  131. "edit": "allow"
  132. }
  133. }
  134. ```
  135. To narzędzie stosuje pliki różnicowe (diffs) do bazy kodu. Przydatne do stosowania zmian z różnych źródeł.
  136. :::note
  137. Narzędzie `patch` jest kontrolowane przez uprawnienie `edit`, które obejmuje wszystkie modyfikacje plików (`edit`, `write`, `patch`).
  138. :::
  139. ---
  140. ### skill
  141. Załaduj [umiejętność](/docs/skills) (plik `SKILL.md`) i zwróć jej treść w rozmowie.
  142. ```json title="opencode.json" {4}
  143. {
  144. "$schema": "https://opencode.ai/config.json",
  145. "permission": {
  146. "skill": "allow"
  147. }
  148. }
  149. ```
  150. ---
  151. ### todowrite
  152. Zarządzaj listami zadań (todo) podczas sesji kodowania.
  153. ```json title="opencode.json" {4}
  154. {
  155. "$schema": "https://opencode.ai/config.json",
  156. "permission": {
  157. "todowrite": "allow"
  158. }
  159. }
  160. ```
  161. Tworzy i aktualizuje listy zadań w celu śledzenia postępu podczas złożonych operacji. LLM wykorzystuje to do organizowania zadań wieloetapowych.
  162. :::note
  163. To narzędzie jest domyślnie wyłączone dla subagentów, ale można je włączyć ręcznie. [Dowiedz się więcej](/docs/agents/#permissions)
  164. :::
  165. ---
  166. ### webfetch
  167. Pobieraj treści z sieci.
  168. ```json title="opencode.json" {4}
  169. {
  170. "$schema": "https://opencode.ai/config.json",
  171. "permission": {
  172. "webfetch": "allow"
  173. }
  174. }
  175. ```
  176. Umożliwia LLM pobieranie i odczytywanie stron internetowych. Przydatne do wyszukiwania dokumentacji lub zasobów online.
  177. ---
  178. ### websearch
  179. Wyszukaj informacje w Internecie.
  180. :::note
  181. To narzędzie jest dostępne tylko w przypadku korzystania z dostawcy OpenCode lub gdy zmienna środowiskowa `OPENCODE_ENABLE_EXA` jest ustawiona na dowolną wartość prawdziwą (np. `true` lub `1`).
  182. Aby włączyć przy uruchamianiu OpenCode:
  183. ```bash
  184. OPENCODE_ENABLE_EXA=1 opencode
  185. ```
  186. :::
  187. ```json title="opencode.json" {4}
  188. {
  189. "$schema": "https://opencode.ai/config.json",
  190. "permission": {
  191. "websearch": "allow"
  192. }
  193. }
  194. ```
  195. Przeszukuje Internet za pomocą Exa AI, aby znaleźć odpowiednie informacje. Przydatne do badania tematów, znajdowania bieżących wydarzeń lub zbierania informacji wykraczających poza zbiór danych treningowych.
  196. Nie jest wymagany żaden klucz API — narzędzie łączy się bezpośrednio z usługą MCP hostowaną przez Exa AI bez uwierzytelniania.
  197. :::tip
  198. Użyj `websearch`, gdy chcesz znaleźć informacje (odkrywanie), i `webfetch`, gdy musisz pobrać treść z określonego adresu URL (pobieranie).
  199. :::
  200. ---
  201. ### question
  202. Zadawaj pytania użytkownikowi podczas wykonywania.
  203. ```json title="opencode.json" {4}
  204. {
  205. "$schema": "https://opencode.ai/config.json",
  206. "permission": {
  207. "question": "allow"
  208. }
  209. }
  210. ```
  211. To narzędzie umożliwia LLM zadawanie pytań użytkownikowi podczas wykonywania zadania. Jest to przydatne do:
  212. - Zbierania preferencji i wymagań użytkownika
  213. - Doprecyzowania niejednoznacznych instrukcji
  214. - Podejmowania decyzji dotyczących implementacji
  215. - Proponowania możliwych kierunków działania
  216. Każde pytanie zawiera nagłówek, tekst pytania i listę opcji. Użytkownicy mogą wybierać spośród dostępnych opcji lub wpisać niestandardową odpowiedź. Jeśli pytań jest wiele, użytkownicy mogą nawigować między nimi przed przesłaniem wszystkich odpowiedzi.
  217. ---
  218. ## Narzędzia niestandardowe
  219. Niestandardowe narzędzia pozwalają zdefiniować własne funkcje, które LLM może wywołać. Są one zdefiniowane w pliku konfiguracyjnym i mogą wykonywać dowolny kod.
  220. [Więcej informacji](/docs/custom-tools) o tworzeniu narzędzi niestandardowych.
  221. ---
  222. ## Serwery MCP
  223. Serwery MCP (Model Context Protocol) umożliwiają integrację zewnętrznych narzędzi i usług. Obejmuje to dostęp do baz danych, integracje API i usługi stron trzecich.
  224. [Dowiedz się więcej](/docs/mcp-servers) o konfigurowaniu serwerów MCP.
  225. ---
  226. ## Szczegóły techniczne
  227. Wewnętrznie narzędzia takie jak `grep` i `glob` używają [ripgrep](https://github.com/BurntSushi/ripgrep). Domyślnie ripgrep respektuje wzorce `.gitignore`, co oznacza, że pliki i katalogi wymienione w Twoim `.gitignore` zostaną wykluczone z wyszukiwań i list.
  228. ---
  229. ### Ignorowanie plików
  230. Aby uwzględnić pliki, które normalnie byłyby ignorowane, utwórz plik `.ignore` w katalogu głównym projektu. Ten plik może jawnie zezwalać na określone ścieżki.
  231. ```text title=".ignore"
  232. !node_modules/
  233. !dist/
  234. !build/
  235. ```
  236. Na przykład ten plik `.ignore` pozwala ripgrepowi przeszukiwać katalogi `node_modules/`, `dist/` i `build/`, nawet jeśli są one wymienione w `.gitignore`.