Skip to content

Commit 7b61efe

Browse files
authored
Merge pull request #8 from aep-dev/readme
Add a README
2 parents 78704d0 + 48e51b4 commit 7b61efe

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
1-
# Readme
1+
# AEP MCP Server
2+
The AEP MCP Server is a Model Context Protocol server that will generate MCP resources and tools based off an AEP-compliant API. This allows API developers with AEP-compliant APIs to create MCP resources that read/list their API resources and MCP tools that allow the creation/deletion/updating of their API resources.
23

3-
## User Guide
4+
Visit [aep.dev](https://aep.dev) for more information on the AEP project.
45

5-
## Running the Server
6+
# Installation
7+
```
8+
git clone https://github.com/aep-dev/aep-mcp-server.git
9+
cd aep-mcp-server
10+
npm install
11+
```
12+
13+
# Running the Server
614

715
To run the server locally, use the following command:
816

@@ -17,11 +25,10 @@ Alternatively, if the package is installed globally or published to npm, you can
1725
npx . --openapi-url="http://localhost:8081/openapi.json"
1826
```
1927

20-
## Inspecting the resources
28+
# Inspecting the resources
2129

2230
The `@modelcontextprotocol/inspector` can be used:
2331

2432
```bash
2533
npx @modelcontextprotocol/inspector node src/bin.js --openapi-url="http://localhost:8081/openapi.json"
2634
```
27-

0 commit comments

Comments
 (0)