Skip to content

docs: add kintone-search tool to README#464

Open
chihiro-adachi wants to merge 1 commit into
mainfrom
docs/add-kintone-search-to-readme
Open

docs: add kintone-search tool to README#464
chihiro-adachi wants to merge 1 commit into
mainfrom
docs/add-kintone-search-to-readme

Conversation

@chihiro-adachi

Copy link
Copy Markdown
Contributor

Why

kintone-search ツールが実装されているものの、README のツール一覧に記載がなかったため追加します。

What

  • ツール一覧の表に kintone-search を追加
  • 「使用上の注意」に kintone-search ツールの注意点(API ラボの検索 API を利用しているため挙動が変わりうる旨)を追加
  • 上記に伴い目次(doctoc)を再生成
  • README.md / README_en.md の両方を更新

How to test

  • README.md / README_en.md をプレビューし、ツール一覧の表・注意点セクション・目次のリンクが正しく表示されることを確認

Checklist

  • Updated documentation if it is required.
  • Added tests if it is required.
  • Passed pnpm lint and pnpm test on the root directory.

@chihiro-adachi chihiro-adachi requested a review from a team as a code owner June 1, 2026 23:46
@chihiro-adachi chihiro-adachi requested review from nameless-mc and shabaraba and removed request for a team June 1, 2026 23:46

@nameless-mc nameless-mc left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

全体的に対応どちらでも良いかなという部分なのでApproveしておきます

Comment thread README.md

### `kintone-search`ツールの注意点

- `kintone-search`は[APIラボの検索API](https://github.com/kintone/js-sdk/blob/main/packages/rest-api-client/docs/search.md)を利用しています。そのため、ツールの挙動は予告なく変更される場合があります。

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ここのリンクdevnetの方がいいかも

Comment thread README.md
- `--attachments-dir`または`KINTONE_ATTACHMENTS_DIR`を指定しない場合はツール実行時にエラーになります。
- `--attachments-dir`または`KINTONE_ATTACHMENTS_DIR`に存在しないディレクトリを指定した場合は、ディレクトリを新規作成してからそこに保存されます。

### `kintone-search`ツールの注意点

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

見出しをkintone-searchにするよりも実験中の機能とかを見出しにした方が自然な気がしました

Comment thread README.md

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(別対応可)
kintone-get-apps / kintone-add-app / kintone-search に関してID/PW認証でしか使えないことをどこかに書いても良さそう

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants