Skip to content

Commit 7c0507c

Browse files
Updating CONTRIBUTING.md to point to this repository
1 parent c56504b commit 7c0507c

File tree

1 file changed

+6
-28
lines changed

1 file changed

+6
-28
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Contributing to @gleanwork/mcp-server
1+
# Contributing to @gleanwork/configure-mcp-server
22

33
Thank you for your interest in contributing to the Glean MCP Server! This document provides guidelines and instructions for development.
44

@@ -7,8 +7,8 @@ Thank you for your interest in contributing to the Glean MCP Server! This docume
77
1. Clone the repository:
88

99
```bash
10-
git clone https://github.com/gleanwork/mcp-server.git
11-
cd mcp-server
10+
git clone https://github.com/gleanwork/configure-mcp-server.git
11+
cd configure-mcp-server
1212
```
1313

1414
1. Ensure `node` and `npm` are installed. This project has a built-in
@@ -38,34 +38,12 @@ npm run build
3838
npm test
3939
```
4040

41-
## Repo Organization
41+
## Running the CLI Locally
4242

43-
The repository is structured as a monorepo with the following packages:
44-
45-
- `@gleanwork/configure-mcp-server` a tool for configuring popular MCP clients to use Glean.
46-
- `@gleanwork/local-mcp-server` the stdio MCP server that exposes Glean APIs to local assistants.
47-
- `@gleanwork/mcp-server-utils` a collection of utilities used by both the configure tool and local mcp server.
48-
49-
## Running the Server Locally
50-
51-
The server communicates via stdio, making it ideal for integration with AI models and other tools:
52-
53-
```bash
54-
node packages/local-server/build/index.js
55-
```
56-
57-
Input and output follow the JSON-RPC 2.0 protocol, with each message on a new line.
58-
59-
## Documentation
60-
61-
### Running Documentation Locally
43+
The CLI is built into the `build` directory:
6244

6345
```bash
64-
# Install dependencies
65-
npm install
66-
67-
# Start development server
68-
npm docs:dev
46+
node ./build/index.js [command]
6947
```
7048

7149
## Making Changes

0 commit comments

Comments
 (0)