phil/gptel-got
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update argument descriptions

Browse source
This commit is contained in:
Phil Bajsicki 2025-04-16 20:54:45 +02:00
parent 6240a40ff0
commit aaed27319b
2 changed files with 12 additions and 16 deletions

16
README.org
View file

@ -528,7 +528,7 @@ But, any customizations to tweak this is left to the user, as everyone has their
(gptel-make-tool (gptel-make-tool
:function #'gptel-org-tools--org-ql-select-dates :function #'gptel-org-tools--org-ql-select-dates
:name "org-ql-select-dates" :name "org-ql-select-dates"
:description "Extract org subtree by date in YYYY or YYYY-MM format" :description "Extract org subtree by date in YYYY or YYYY-MM format. Prefer using this first when request specifies for time periods."
:args (list '(:name "buffer" :args (list '(:name "buffer"
:type string :type string
:description "Buffer name.") :description "Buffer name.")
@ -551,10 +551,10 @@ It works, in principle, but I haven't been able to find a use for it yet. The re
(kill-buffer (current-buffer)) (kill-buffer (current-buffer))
content))) content)))
:name "org-agenda-fortnight" :name "org-agenda-fortnight"
:description "Get the next 14 days of user's org-agenda." :description "Get X days of user's org-agenda."
:args (list '(:name "days" :args (list '(:name "days"
:type integer :type integer
:description "The number of days to look ahead. Default: 14")) :description "Days. Positive = future. Negative = past. Default: 14"))
:category "org")) :category "org"))
#+end_src #+end_src
**** Completely WIP tools **** Completely WIP tools
@ -701,7 +701,7 @@ This pulls all the headings (and their contents) when they match tags (without i
(gptel-make-tool (gptel-make-tool
:function #'gptel-org-tools--org-ql-select-agenda-tags-local :function #'gptel-org-tools--org-ql-select-agenda-tags-local
:name "org-ql-select-agenda-tags-local" :name "org-ql-select-agenda-tags-local"
:description "Run simple word query against all files in (org-agenda-files). WITHOUT tag inheritance, only directly tagged headings." :description "Run single word query against all files in (org-agenda-files). WITHOUT tag inheritance, only directly tagged headings."
:args (list '(:name "query" :args (list '(:name "query"
:type string :type string
:description "A single word to scan for.")) :description "A single word to scan for."))
@ -721,7 +721,7 @@ This pulls all the headings (and their contents) when they match tags (with inhe
(gptel-make-tool (gptel-make-tool
:function #'gptel-org-tools--org-ql-select-agenda-tags :function #'gptel-org-tools--org-ql-select-agenda-tags
:name "org-ql-select-agenda-tags" :name "org-ql-select-agenda-tags"
:description "Run simple word query against all files in (org-agenda-files). WITH tag inheritance." :description "Run single word query against all files in (org-agenda-files). WITH tag inheritance."
:args (list '(:name "query" :args (list '(:name "query"
:type string :type string
:description "A single word to scan for.")) :description "A single word to scan for."))
@ -750,7 +750,7 @@ This means that /every org-mode file I have/ is part of this search.
(gptel-make-tool (gptel-make-tool
:function #'gptel-org-tools--org-ql-select-agenda-rifle :function #'gptel-org-tools--org-ql-select-agenda-rifle
:name "org-ql-select-agenda-rifle" :name "org-ql-select-agenda-rifle"
:description "Run simple word query against all files in (org-agenda-files)" :description "Run single word query against ALL org-mode files (notes)."
:args (list '(:name "query" :args (list '(:name "query"
:type string :type string
:description "The keyword to match entry headings and content against.")) :description "The keyword to match entry headings and content against."))
@ -759,10 +759,6 @@ This means that /every org-mode file I have/ is part of this search.
** End ** End
:PROPERTIES:
:CREATED: <2025-04-14 Mon 22:46>
:VISIBILITY: folded
:END:
#+begin_src elisp #+begin_src elisp
(provide 'gptel-org-tools) (provide 'gptel-org-tools)
;;; gptel-org-tools.el ends here ;;; gptel-org-tools.el ends here

12
gptel-org-tools.el
View file

@ -200,7 +200,7 @@
(gptel-make-tool (gptel-make-tool
:function #'gptel-org-tools--org-ql-select-dates :function #'gptel-org-tools--org-ql-select-dates
:name "org-ql-select-dates" :name "org-ql-select-dates"
:description "Extract org subtree by date in YYYY or YYYY-MM format" :description "Extract org subtree by date in YYYY or YYYY-MM format. Prefer using this first when request specifies for time periods."
:args (list '(:name "buffer" :args (list '(:name "buffer"
:type string :type string
:description "Buffer name.") :description "Buffer name.")
@ -218,10 +218,10 @@
(kill-buffer (current-buffer)) (kill-buffer (current-buffer))
content))) content)))
:name "org-agenda-fortnight" :name "org-agenda-fortnight"
:description "Get the next 14 days of user's org-agenda." :description "Get X days of user's org-agenda."
:args (list '(:name "days" :args (list '(:name "days"
:type integer :type integer
:description "The number of days to look ahead. Default: 14")) :description "Days. Positive = future. Negative = past. Default: 14"))
:category "org")) :category "org"))
(defun gptel-org-tools--org-ql-select-headings (buf query) (defun gptel-org-tools--org-ql-select-headings (buf query)
@ -340,7 +340,7 @@
(gptel-make-tool (gptel-make-tool
:function #'gptel-org-tools--org-ql-select-agenda-tags-local :function #'gptel-org-tools--org-ql-select-agenda-tags-local
:name "org-ql-select-agenda-tags-local" :name "org-ql-select-agenda-tags-local"
:description "Run simple word query against all files in (org-agenda-files). WITHOUT tag inheritance, only directly tagged headings." :description "Run single word query against all files in (org-agenda-files). WITHOUT tag inheritance, only directly tagged headings."
:args (list '(:name "query" :args (list '(:name "query"
:type string :type string
:description "A single word to scan for.")) :description "A single word to scan for."))
@ -356,7 +356,7 @@
(gptel-make-tool (gptel-make-tool
:function #'gptel-org-tools--org-ql-select-agenda-tags :function #'gptel-org-tools--org-ql-select-agenda-tags
:name "org-ql-select-agenda-tags" :name "org-ql-select-agenda-tags"
:description "Run simple word query against all files in (org-agenda-files). WITH tag inheritance." :description "Run single word query against all files in (org-agenda-files). WITH tag inheritance."
:args (list '(:name "query" :args (list '(:name "query"
:type string :type string
:description "A single word to scan for.")) :description "A single word to scan for."))
@ -372,7 +372,7 @@
(gptel-make-tool (gptel-make-tool
:function #'gptel-org-tools--org-ql-select-agenda-rifle :function #'gptel-org-tools--org-ql-select-agenda-rifle
:name "org-ql-select-agenda-rifle" :name "org-ql-select-agenda-rifle"
:description "Run simple word query against all files in (org-agenda-files)" :description "Run single word query against ALL org-mode files (notes)."
:args (list '(:name "query" :args (list '(:name "query"
:type string :type string
:description "The keyword to match entry headings and content against.")) :description "The keyword to match entry headings and content against."))