Skip to content

Commit caa40d1

Browse files
committed
add readme
1 parent 3e07674 commit caa40d1

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# AEP MCP Server
2+
The AEP MCP Server is a Model Context Protocol server that will generate resources and tools based off an AEP-compliant API.
3+
4+
Visit [aep.dev](https://aep.dev) for more information on the AEP project.
5+
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+
# Configuring the server
14+
15+
The server can be configured by modifying three variables in `src/server.ts`:
16+
17+
1. `openapiUrl`: The URL to your OpenAPI specification.
18+
```typescript
19+
const openapiUrl = "https://my-open-api-spec.com/spec.json";
20+
```
21+
22+
2. `prefix`: (optional) The API prefix path that will be used for all API calls. If all paths in your OpenAPI spec share a common prefix, list it here. Set to the empty string if no prefix exists.
23+
```typescript
24+
const prefix = "/cloud/v2";
25+
```
26+
27+
3. Headers: The server sends headers with each API request. We recommend not hard-coding any authentication credentials into the server file and instead using environment variables. You can modify these in the `headers` object:
28+
```typescript
29+
const headers: Record<string, string> = {
30+
"Content-Type": "application/json",
31+
"x-api-key": process.env.API_KEY!,
32+
};
33+
```
34+
35+
# Running the server
36+
```
37+
npm run build
38+
node dist/server.js
39+
```
40+
41+

0 commit comments

Comments
 (0)