# List readme

URL: https://docs.hanzo.ai/docs/openapi/git/get-git-repos-by-name-readme

> Returns the README at the tree root as plain text — unrendered, so the caller decides how to present it.

`GET /v1/git/repos/{name}/readme`

> [Git →](https://docs.hanzo.ai/docs/openapi/git) · [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides)

|               |                                                   |
| ------------- | ------------------------------------------------- |
| **Address**   | `https://api.hanzo.ai/v1/git/repos/{name}/readme` |
| **Method**    | `GET`                                             |
| **Operation** | `get_git_repos_by_name_readme`                    |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY`            |

Returns the README at the tree root as plain text — unrendered, so
the caller decides how to present it. A repo with no README is not found.

## Request

2 fields.

| Field  | In    | Type   | Required | Description                                                  |
| ------ | ----- | ------ | -------- | ------------------------------------------------------------ |
| `name` | path  | string | yes      | Name is the repo to read, from the :name path segment.       |
| `ref`  | query | string | —        | Ref is a branch, tag or commit; empty means the repo's HEAD. |

## Response

| Status    | Body            | Meaning |
| --------- | --------------- | ------- |
| `200`     | git.readmeJSON  | ok      |
| `default` | problem-details | refused |

`200` body — 3 fields.

| Field      | In   | Type   | Always | Description                                                      |
| ---------- | ---- | ------ | ------ | ---------------------------------------------------------------- |
| `content`  | body | string | —      | Content is the file's text, verbatim and unrendered.             |
| `encoding` | body | string | —      | Encoding is always "utf8" — a README is text by definition.      |
| `path`     | body | string | —      | Path is the file the README was found at (README.md, README, …). |

Failure carries the platform error shape — see [Errors](https://docs.hanzo.ai/docs/errors).

## Examples

**CLI**

```bash
hanzo git repos readme <name>
```

**SDK**

**.ts**

```ts
import { Configuration, GitApi } from 'hanzoai';

const api = new GitApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getGitReposByNameReadme({ name: 'name' });
```

**.py**

```python
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import GitApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = GitApi(client).get_git_repos_by_name_readme(name='name')
```

**.go**

```go
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.GitAPI.GetGitReposByNameReadme(context.Background()).Execute()
if err != nil {
	return err
}
```

**.rs**

```rust
use hanzo_client::apis::{configuration::Configuration, git_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = git_api::get_git_repos_by_name_readme(&cfg, Default::default()).await?;
```

**.java**

```java
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.GitApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new GitApi(client).getGitReposByNameReadme();
```

**HTTP**

```bash
curl https://api.hanzo.ai/v1/git/repos/<name>/readme \
  -H "Authorization: Bearer $HANZO_API_KEY"
```

**MCP**

MCP reaches **git** through the `git` tool, which names its 38 operations with its own verbs — this one among them, under a name only MCP declares. `describe` explains any of them:

```bash
curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "list_git_keys"
         }
       }
     }'
```

---

[Git API](https://docs.hanzo.ai/docs/openapi/git) · [All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)