Merge pull request #6 from ITZSHOAIB/feat-graphql-tool

feat: A new graphql tool added that LLM models can invoke

Author: ITZSHOAIB

.changeset/all-snakes-beg.md

@@ -0,0 +1,5 @@
+---
+"graphql-agent-tool": patch
+---
+
+feat: A new Graphql Tool that LLM models will be able to invoke

.changeset/config.json

@@ -2,7 +2,7 @@
   "$schema": "https://unpkg.com/@changesets/config@3.0.3/schema.json",
   "changelog": [
     "@changesets/changelog-github",
-    { "repo": "ITZSHOAIB/typescript-package-boilerplate" }
+    { "repo": "ITZSHOAIB/graphql-agent-tool" }
   ],
   "commit": false,
   "fixed": [],

.github/workflows/publish-on-main.yml

@@ -10,15 +10,11 @@ concurrency:
 
 jobs:
   checks:
-    # Remove this line to enable the job
-    if: ${{ false }}
     name: Checks
     uses: ./.github/workflows/pre-checks.yml
     secrets: inherit
 
-  publish:
-    # Remove this line to enable the job
-    if: ${{ false }} 
+  publish: 
     name: Publish
     needs: checks
     runs-on: ubuntu-latest

.github/workflows/pull-request.yml

@@ -9,8 +9,6 @@ concurrency:
 
 jobs:
   checks:
-    # Remove this line to enable the job
-    if: ${{ false }}
     name: Checks
     uses: ./.github/workflows/pre-checks.yml
     secrets: inherit

.gitignore

@@ -1,3 +1,4 @@
 node_modules
 dist
-coverage
+coverage
+.env

.vscode/extensions.json

@@ -1,3 +1,3 @@
 {
-  "recommendations": ["orta.vscode-twoslash-queries", "biomejs.biome"]
+  "recommendations": ["biomejs.biome"]
 }

examples/direct-call/invoke.ts

@@ -0,0 +1,25 @@
+import { GraphqlAgentTool } from "graphql-agent-tool";
+
+export const invoke = async () => {
+  const graphqlCapitalTool = new GraphqlAgentTool({
+    name: "getCountryCapital",
+    purpose:
+      "Retrieves the capital city of a country using its ISO country code. The tool expects a country code in ISO format (e.g., 'IN' for India, 'US' for United States). Input should be provided in the format {variables: {countryCode: <countryCode>}}.",
+    url: "https://countries.trevorblades.com",
+    query: `
+    query GetCountryCapital($countryCode: ID!) {
+      country(code: $countryCode) {
+        capital
+      }
+    }
+    `,
+  }).getTool();
+
+  const response = await graphqlCapitalTool.invoke({
+    variables: {
+      countryCode: "IN",
+    },
+  });
+
+  return response;
+};

examples/response-parser/invoke.ts

@@ -0,0 +1,29 @@
+import { GraphqlAgentTool } from "graphql-agent-tool";
+
+export const invoke = async () => {
+  const graphqlCapitalTool = new GraphqlAgentTool({
+    name: "getCountryCapital",
+    purpose:
+      "Retrieves the capital city of a country using its ISO country code. The tool expects a country code in ISO format (e.g., 'IN' for India, 'US' for United States). Input should be provided in the format {variables: {countryCode: <countryCode>}}.",
+    url: "https://countries.trevorblades.com",
+    query: `
+    query GetCountryCapital($countryCode: ID!) {
+      country(code: $countryCode) {
+        capital
+      }
+    }
+    `,
+    responseParser: (response: unknown) => {
+      const { data } = response as { data: { country: { capital: string } } };
+      return data.country.capital;
+    },
+  }).getTool();
+
+  const response = await graphqlCapitalTool.invoke({
+    variables: {
+      countryCode: "IN",
+    },
+  });
+
+  return response;
+};

examples/with-llm-model/invoke.ts

@@ -0,0 +1,23 @@
+import { GraphqlAgentTool } from "graphql-agent-tool";
+import { mistralModel } from "./models.js";
+
+export const invoke = async (prompt: string) => {
+  const graphqlCapitalTool = new GraphqlAgentTool({
+    name: "getCountryCapital",
+    purpose:
+      "Retrieves the capital city of a country using its ISO country code. The tool expects a country code in ISO format (e.g., 'IN' for India, 'US' for United States). Input should be provided in the format {variables: {countryCode: <countryCode>}}.",
+    url: "https://countries.trevorblades.com",
+    query: `
+    query GetCountryCapital($countryCode: ID!) {
+      country(code: $countryCode) {
+        capital
+      }
+    }
+    `,
+  }).getTool();
+
+  const modelWithTools = mistralModel.bindTools([graphqlCapitalTool]);
+  const response = await modelWithTools.invoke(prompt);
+
+  return response;
+};

examples/with-llm-model/models.ts

@@ -0,0 +1,8 @@
+import { ChatMistralAI } from "@langchain/mistralai";
+
+// Mistral model
+export const mistralModel = new ChatMistralAI({
+  model: "mistral-small-latest",
+  apiKey: process.env.MISTRAL_API_KEY || "",
+  temperature: 0.0,
+});