> ## Documentation Index
> Fetch the complete documentation index at: https://docs.useagents.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Editing Your Tool

> Update every field on the Edit Tool page so agents can discover your tool and use it correctly.

After creating a tool, open **Edit Tool** anytime from the dashboard. Changes save to your **draft** until you [deploy](/developers/publishing) them to the live registry.

Need help drafting metadata? Use [UseAgents Copilot](/developers/copilot) on the tool page for proposals, research, and deploy assistance.

## Edit a tool

1. Go to the [dashboard](https://useagents.site/dashboard).
2. Open your tool from the list.
3. Click **Edit Tool** in the sidebar.
4. Update any field in the form.
5. Click **Save changes**.

Saved edits stay on the draft. They are not visible in search or to agents until you deploy.

<Note>
  Archived tools cannot be edited. Restore the tool from settings before making changes.
</Note>

## Deployment readiness

At the top of the edit page, **Deployment readiness** tracks required fields for deploy:

| Required field  | Ready when                                   |
| --------------- | -------------------------------------------- |
| **Name**        | Not empty                                    |
| **Slug**        | At least 3 characters                        |
| **Tagline**     | At least 10 characters                       |
| **Description** | Not empty                                    |
| **Quickstart**  | At least one language has a quickstart entry |
| **Categories**  | At least one category selected               |

Optional fields (image, input/output shape, pitfalls, tags, languages, frameworks, and source links) improve quality and discovery but are not required for readiness.

## Form sections

The edit form is organized into three sections:

1. **Define your tool** — identity and description
2. **Make your tool usable by agents** — how to install and call it
3. **Help agents discover your tool** — tags, categories, and source links

***

## Define your tool

What your tool is and why it exists.

### Tool image

Upload a logo or icon for the tool. It appears on tool cards and detail pages.

* Recommended aspect ratio: **1:1**
* Maximum size: **5 MB**
* Optional

### Name

The display name of your tool. Required for readiness.

* Minimum **1** character
* Maximum **100** characters
* Changing the name auto-updates the slug until you edit the slug manually

### Slug URL

The URL-friendly identifier. It appears as `useagents.site/t/your-slug`.

* Required for readiness
* Minimum **3** characters, maximum **64**
* Must be unique across the registry
* Auto-generated from the name by default; you can override it
* Saved directly on the tool (not only as a draft field) so uniqueness stays enforced

### Tagline

A one-sentence summary shown on tool cards (`shortDescription` in the API).

* Required for readiness
* **10 to 160** characters
* Keep it concise and human-readable
* Focus on what the tool does and who it is for
* Example: *"Agent-ready billing API for SaaS apps."*

### What does it do? (Description)

Explain the tool's job, the problem it solves, and when an agent should choose it.

* Required for readiness
* Maximum **500** characters
* Focus on functionality and integrations, not marketing copy
* Help agents understand when and how to recommend the tool

***

## Make your tool usable by agents

This section tells agents exactly how to use your tool. Be specific — vague instructions lead to incorrect usage.

### Languages (prerequisite for quickstart)

Select languages under **Help agents discover your tool** first. Quickstart tabs appear for each selected language. If no languages are selected, the quickstart editor shows a prompt to select languages in the discovery section.

### Quickstart (per language)

Minimal install and usage snippets for each supported language. Required for readiness (at least one language entry).

For each language tab:

| Subfield            | Required                                | Limits                  | Description                                                                           |
| ------------------- | --------------------------------------- | ----------------------- | ------------------------------------------------------------------------------------- |
| **Install command** | Optional                                | Max **500** characters  | Package-manager install line (e.g. `npm install @myorg/sdk`, `pip install myorg-sdk`) |
| **Usage code**      | Required when a quickstart entry exists | Max **4000** characters | Minimal working example for that language                                             |

Notes:

* Quickstart keys are tied to selected languages. Removing a language prunes that language's quickstart on save.
* Install commands should start with a standard package manager (`npm`, `pnpm`, `yarn`, `bun`, `pip`, `uv`, `cargo`, `go`, `gem`, `composer`, or `docker`). Unsafe install commands can fail deployment verification.

### What does this tool take as input? (Input shape)

Describe parameters, types, and what is required vs optional.

* Optional
* Maximum **2000** characters
* Example: `{ url: string; method?: 'GET' | 'POST' }`

### What does this tool return? (Output shape)

Describe the response shape an agent should expect, including success and error cases when useful.

* Optional
* Maximum **2000** characters
* Example: `{ success: boolean; data: any }`

### Common pitfalls

Gotchas or mistakes that are easy to miss in official docs (rate limits, auth edge cases, async behavior, and similar).

* Optional
* Maximum **20** pitfalls
* Maximum **300** characters per pitfall
* Use the **Add pitfall** / **Remove** controls in the form

***

## Help agents discover your tool

Helps agents find your tool when searching. Prefer accuracy over volume.

### Tags

Keywords that describe features, use cases, or technical capabilities.

* Optional
* Maximum **15** tags
* Maximum **30** characters per tag
* Tags are lowercased automatically
* Avoid repeating category names as tags

### Categorization

| Field          | Required            | Description                                                                              |
| -------------- | ------------------- | ---------------------------------------------------------------------------------------- |
| **Categories** | Yes (for readiness) | Primary product categories (e.g. Authentication, CLI, SDK, API). Select at least one.    |
| **Languages**  | Optional            | Languages the tool supports (e.g. TypeScript, Python, Go). Also unlocks quickstart tabs. |
| **Frameworks** | Optional            | Frameworks the tool integrates with (e.g. React, Next.js).                               |

Accurate categorization improves filter and ranking quality in search.

### Sources

Supporting links that help agents verify details and point users to the right place. Leave blank if a link does not apply. When provided, each must be a valid URL.

| Field        | Description                            |
| ------------ | -------------------------------------- |
| **Website**  | Tool homepage                          |
| **Repo URL** | GitHub or other source repository      |
| **Docs URL** | Documentation site or docs entry point |

***

## Fields reference (summary)

| Field                       | Section   | Required for deploy readiness     | Limits                            |
| --------------------------- | --------- | --------------------------------- | --------------------------------- |
| **Tool image**              | Define    | No                                | 1:1 recommended, up to 5 MB       |
| **Name**                    | Define    | Yes                               | 1–100 characters                  |
| **Slug URL**                | Define    | Yes                               | 3–64 characters, unique           |
| **Tagline**                 | Define    | Yes                               | 10–160 characters                 |
| **Description**             | Define    | Yes                               | Max 500 characters                |
| **Quickstart — install**    | Usage     | No (per language)                 | Max 500 characters                |
| **Quickstart — usage code** | Usage     | Yes (at least one language entry) | Max 4000 characters               |
| **Input shape**             | Usage     | No                                | Max 2000 characters               |
| **Output shape**            | Usage     | No                                | Max 2000 characters               |
| **Common pitfalls**         | Usage     | No                                | Max 20 items, 300 characters each |
| **Tags**                    | Discovery | No                                | Max 15 tags, 30 characters each   |
| **Categories**              | Discovery | Yes                               | At least one                      |
| **Languages**               | Discovery | No                                | Needed for quickstart tabs        |
| **Frameworks**              | Discovery | No                                | —                                 |
| **Website**                 | Discovery | No                                | Valid URL when set                |
| **Repo URL**                | Discovery | No                                | Valid URL when set                |
| **Docs URL**                | Discovery | No                                | Valid URL when set                |

## Best practices

* Lead with the tool's actual capability, not generic praise.
* Write quickstarts that agents can copy and run with minimal setup.
* Document real input and output shapes instead of vague prose.
* Call out non-obvious pitfalls (auth, rate limits, pagination, async behavior).
* Use specific categories and tags instead of broad labels.
* Prefer canonical docs and repository URLs over marketing pages when possible.

## Review before saving

* Check that the slug is stable and readable.
* Make sure the description explains what the tool does, not only why it is great.
* Confirm each selected language has a usable quickstart when you plan to deploy.
* Keep categories, tags, languages, and frameworks aligned with the real integration surface.

## Next steps

* [Reviewing Changes](/developers/changes) to inspect draft changes
* [Publishing & Deployments](/developers/publishing) to make updates live
* [Prompt Injection & Safe Metadata](/developers/prompt-injection) for deployment safety checks