Skip to content

Commit

Permalink
docs: add more tool docs
Browse files Browse the repository at this point in the history
  • Loading branch information
transitive-bullshit committed Aug 8, 2024
1 parent 20d468c commit 8ea89ea
Show file tree
Hide file tree
Showing 32 changed files with 1,168 additions and 5 deletions.
33 changes: 32 additions & 1 deletion docs/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,38 @@
},
{
"group": "Tools",
"pages": ["tools/bing", "tools/weather"]
"pages": [
"tools/bing",
"tools/calculator",
"tools/clearbit",
"tools/dexa",
"tools/diffbot",
"tools/e2b",
"tools/exa",
"tools/firecrawl",
"tools/hacker-news",
"tools/hunter",
"tools/jina",
"tools/midjourney",
"tools/novu",
"tools/people-data-labs",
"tools/perigon",
"tools/polygon",
"tools/predict-leads",
"tools/proxycurl",
"tools/searxng",
"tools/serpapi",
"tools/serper",
"tools/slack",
"tools/social-data",
"tools/tavily",
"tools/twilio",
"tools/twitter",
"tools/weather",
"tools/wikidata",
"tools/wikipedia",
"tools/wolfram-alpha"
]
}
],
"footerSocials": {
Expand Down
35 changes: 35 additions & 0 deletions docs/tools/calculator.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
title: Calculator
description: A simple calculator tool.
---

- package: `@agentic/calculator`
- exports: `function calculator`
- env vars: _none_
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/calculator/src/calculator.ts)
- [api docs](https://mathjs.org)

## Install

<CodeGroup>
```bash npm
npm install @agentic/calculator
```

```bash yarn
yarn add @agentic/calculator
```

```bash pnpm
pnpm add @agentic/calculator
```

</CodeGroup>

## Usage

```ts
import { calculator } from '@agentic/calculator'

const res = await calculator({ expr: '1 + 1' })
```
36 changes: 36 additions & 0 deletions docs/tools/clearbit.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
title: Clearbit
description: Resolving and enriching people and company data.
---

- package: `@agentic/clearbit`
- exports: `class ClearbitClient`, `namespace clearbit`
- env vars: `CLEARBIT_API_KEY`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/clearbit/src/clearbit-client.ts)
- [api docs](https://dashboard.clearbit.com/docs)

## Install

<CodeGroup>
```bash npm
npm install @agentic/clearbit
```

```bash yarn
yarn add @agentic/clearbit
```

```bash pnpm
pnpm add @agentic/clearbit
```

</CodeGroup>

## Usage

```ts
import { ClearbitClient } from '@agentic/clearbit'

const clearbit = new ClearbitClient()
const res = await clearbit.companyEnrichment({ domain: 'apple.com' })
```
41 changes: 41 additions & 0 deletions docs/tools/dexa.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
title: Dexa
description: Answers questions from the world's best podcasters.
---

<Warning>
The [Dexa](https://dexa.ai) API is currently only available as a closed beta.
</Warning>

- package: `@agentic/dexa`
- exports:
- `class DexaClient`, `namespace dexa`
- `class ScraperClient`, `namespace scraper`
- env vars: `DEXA_API_KEY`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/dexa/src/dexa-client.ts)

## Install

<CodeGroup>
```bash npm
npm install @agentic/dexa
```

```bash yarn
yarn add @agentic/dexa
```

```bash pnpm
pnpm add @agentic/dexa
```

</CodeGroup>

## Usage

```ts
import { DexaClient } from '@agentic/dexa'

const dexa = new DexaClient()
const res = await dexa.search('latest news')
```
38 changes: 38 additions & 0 deletions docs/tools/diffbot.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: Diffbot
description: Diffbot API client.
---

Diffbot provides web page classification and scraping. It also provides access to a knowledge graph with the ability to perform person and company data enrichment.

- package: `@agentic/diffbot`
- exports: `class DiffbotClient`, `namespace diffbot`
- env vars: `DIFFBOT_API_KEY`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/diffbot/src/diffbot-client.ts)
- [api docs](https://docs.diffbot.com)

## Install

<CodeGroup>
```bash npm
npm install @agentic/diffbot
```

```bash yarn
yarn add @agentic/diffbot
```

```bash pnpm
pnpm add @agentic/diffbot
```

</CodeGroup>

## Usage

```ts
import { DiffbotClient } from '@agentic/diffbot'

const diffbot = new DiffbotClient()
const res = await diffbot.analyzeUrl('https://example.com')
```
37 changes: 37 additions & 0 deletions docs/tools/e2b.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: E2B
description: Hosted Python code interpreter sandbox.
---

Hosted Python code intrepreter sandbox which is really useful for data analysis, flexible code execution, and advanced reasoning on-the-fly.

- package: `@agentic/e2b`
- exports: `function e2b`
- env vars: `E2B_API_KEY`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/e2b/src/e2b.ts)
- [api docs](https://e2b.dev)

## Install

<CodeGroup>
```bash npm
npm install @agentic/e2b @e2b/code-interpreter
```

```bash yarn
yarn add @agentic/e2b @e2b/code-interpreter
```

```bash pnpm
pnpm add @agentic/e2b @e2b/code-interpreter
```

</CodeGroup>

## Usage

```ts
import { e2b } from '@agentic/e2b'

const res = await e2b({ code: 'print("Hello, World")' })
```
36 changes: 36 additions & 0 deletions docs/tools/exa.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
title: Exa
description: Web search tailored for LLMs.
---

- package: `@agentic/exa`
- exports: `class ExaClient`, `namespace exa`
- env vars: `EXA_API_KEY`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/exa/src/exa-client.ts)
- [api docs](https://docs.exa.ai)

## Install

<CodeGroup>
```bash npm
npm install @agentic/exa
```

```bash yarn
yarn add @agentic/exa
```

```bash pnpm
pnpm add @agentic/exa
```

</CodeGroup>

## Usage

```ts
import { ExaClient } from '@agentic/exa'

const exa = new ExaClient()
const res = await exa.search('latest news')
```
38 changes: 38 additions & 0 deletions docs/tools/firecrawl.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: Firecrawl
description: Website scraping and structured data extraction.
---

Turn websites into LLM-ready data. Crawl and convert any website into clean markdown or structured data.

- package: `@agentic/firecrawl`
- exports: `class FirecrawlClient`, `namespace firecrawl`
- env vars: `FIRECRAWL_API_KEY`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/firecrawl/src/firecrawl-client.ts)
- [api docs](https://www.firecrawl.dev)

## Install

<CodeGroup>
```bash npm
npm install @agentic/firecrawl
```

```bash yarn
yarn add @agentic/firecrawl
```

```bash pnpm
pnpm add @agentic/firecrawl
```

</CodeGroup>

## Usage

```ts
import { FirecrawlClient } from '@agentic/firecrawl'

const firecrawl = new FirecrawlClient()
const res = await firecrawl.scrapeUrl('https://example.com')
```
38 changes: 38 additions & 0 deletions docs/tools/hacker-news.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: HackerNews
description: Basic client for the official Hacker News API.
---

Note that the [HN Algolia API](https://hn.algolia.com/api) seems to no longer be available, so we can't add search without quite a bit of overhead.

- package: `@agentic/hacker-news`
- exports: `class HackerNewsClient`, `namespace hackernews`
- env vars: `HACKER_NEWS_API_USER_AGENT` (_optional_)
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/hacker-news/src/hacker-news-client.ts)
- [api docs](https://github.com/HackerNews/API)

## Install

<CodeGroup>
```bash npm
npm install @agentic/hacker-news
```

```bash yarn
yarn add @agentic/hacker-news
```

```bash pnpm
pnpm add @agentic/hacker-news
```

</CodeGroup>

## Usage

```ts
import { HackerNewsClient } from '@agentic/hacker-news'

const hn = new HackerNewsClient()
const res = await hn.getTopStories()
```
41 changes: 41 additions & 0 deletions docs/tools/hunter.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
title: Hunter
description: Email finder, verifier, and enrichment.
---

- package: `@agentic/hunter`
- exports: `class HunterClient`, `namespace hunter`
- env vars: `HUNTER_API_KEY`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/hunter/src/hunter-client.ts)
- [api docs]()

## Install

<CodeGroup>
```bash npm
npm install @agentic/hunter
```

```bash yarn
yarn add @agentic/hunter
```

```bash pnpm
pnpm add @agentic/hunter
```

</CodeGroup>

## Usage

```ts
import { HunterClient } from '@agentic/hunter'

const hunter = new HunterClient()
const res0 = await hunter.domainSearch('apple.com')
const res1 = await hunter.emailFinder({
domain: 'transitivebullsh.it',
first_name: 'travis',
last_name: 'fischer'
})
```
Loading

0 comments on commit 8ea89ea

Please sign in to comment.