Skip to content

Commit c7880c8

Browse files
authored
docs: update README for new implementation (#26)
Signed-off-by: Shiwei Zhang <shizh@microsoft.com>
1 parent cab91ab commit c7880c8

1 file changed

Lines changed: 11 additions & 2 deletions

File tree

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
## Usage
44

5-
The ORAS MCP Server can be configured to be run using the [vscode agent mode](https://code.visualstudio.com/docs/copilot/chat/chat-agent-mode).
5+
Configure the ORAS MCP Server to run inside [VS Code agent mode](https://code.visualstudio.com/docs/copilot/chat/chat-agent-mode) for registry-aware chats.
66

7-
Since this MCP Server requires a local ORAS CLI, please make sure you have installed the [oras](https://github.com/oras-project/oras) (version >= `v1.3.0-beta.1`).
7+
The server is implemented with the [`oras-go`](https://github.com/oras-project/oras-go) library and does not depend on the [`oras`](https://github.com/oras-project/oras) CLI.
88

99
### Setup with Docker
1010

@@ -32,6 +32,15 @@ Add the following code to `.vscode/mcp.json`:
3232
}
3333
```
3434

35+
### Authentication
36+
37+
If you need to access private registries through the server, log in ahead of time using either the ORAS CLI or Docker:
38+
39+
- `oras login <registry>`
40+
- `docker login <registry>`
41+
42+
The server will reuse the credentials from your local credential store when available.
43+
3544
## Example Chats
3645

3746
Q: What platform does the image ghcr.io/oras-project/oras support?

0 commit comments

Comments
 (0)