Skip to content

Commit 16498af

Browse files
add project files
1 parent 2edbce5 commit 16498af

22 files changed

Lines changed: 2746 additions & 0 deletions

.github/workflows/ci.yml

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
pull_request:
7+
branches: [ main ]
8+
9+
jobs:
10+
build:
11+
runs-on: ubuntu-latest
12+
13+
strategy:
14+
matrix:
15+
node-version: [18.x, 20.x]
16+
17+
steps:
18+
- uses: actions/checkout@v3
19+
20+
- name: Use Node.js ${{ matrix.node-version }}
21+
uses: actions/setup-node@v3
22+
with:
23+
node-version: ${{ matrix.node-version }}
24+
25+
- name: Install dependencies
26+
run: npm ci
27+
28+
- name: Build
29+
run: npm run build
30+
31+
- name: Test
32+
run: node test.js
33+
34+
- name: Test CLI
35+
run: node dist/index.js --help
36+
37+
- name: Upload build artifacts
38+
uses: actions/upload-artifact@v3
39+
with:
40+
name: dist-${{ matrix.node-version }}
41+
path: dist/
42+
43+
test-mcp:
44+
runs-on: ubuntu-latest
45+
needs: build
46+
47+
steps:
48+
- uses: actions/checkout@v3
49+
50+
- name: Use Node.js 20.x
51+
uses: actions/setup-node@v3
52+
with:
53+
node-version: 20.x
54+
55+
- name: Install dependencies
56+
run: npm ci
57+
58+
- name: Build
59+
run: npm run build
60+
61+
- name: Test with MCP Inspector
62+
run: |
63+
npx @modelcontextprotocol/inspector node dist/index.js &
64+
sleep 5
65+
kill %1
66+
continue-on-error: true

.github/workflows/publish.yml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Publish to NPM
2+
3+
on:
4+
release:
5+
types: [created]
6+
7+
jobs:
8+
publish:
9+
runs-on: ubuntu-latest
10+
11+
steps:
12+
- uses: actions/checkout@v3
13+
14+
- name: Setup Node.js
15+
uses: actions/setup-node@v3
16+
with:
17+
node-version: '20.x'
18+
registry-url: 'https://registry.npmjs.org'
19+
20+
- name: Install dependencies
21+
run: npm ci
22+
23+
- name: Build
24+
run: npm run build
25+
26+
- name: Test
27+
run: node test.js
28+
29+
- name: Publish to NPM
30+
run: npm publish --access public
31+
env:
32+
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Dependencies
2+
node_modules/
3+
npm-debug.log*
4+
yarn-debug.log*
5+
yarn-error.log*
6+
7+
# Build output
8+
dist/
9+
build/
10+
*.tsbuildinfo
11+
12+
# Environment
13+
.env
14+
.env.local
15+
.env.*.local
16+
17+
# IDE
18+
.vscode/
19+
.idea/
20+
*.swp
21+
*.swo
22+
*~
23+
.DS_Store
24+
25+
# Logs
26+
logs/
27+
*.log
28+
29+
# Testing
30+
coverage/
31+
.nyc_output/
32+
33+
# Package manager
34+
package-lock.json
35+
yarn.lock
36+
pnpm-lock.yaml

.npmignore

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Source files
2+
src/
3+
*.ts
4+
tsconfig.json
5+
6+
# Development files
7+
test.js
8+
examples/
9+
docs/
10+
11+
# Git files
12+
.git/
13+
.gitignore
14+
15+
# IDE files
16+
.vscode/
17+
.idea/
18+
*.swp
19+
*.swo
20+
21+
# Build artifacts
22+
*.tsbuildinfo
23+
24+
# Logs
25+
*.log
26+
npm-debug.log*
27+
28+
# Dependencies
29+
node_modules/
30+
31+
# OS files
32+
.DS_Store
33+
Thumbs.db
34+
35+
# Keep only dist/ and essential files
36+
# package.json, README.md, LICENSE are included by default

CONTRIBUTING.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Contributing to Nativelink MCP Server
2+
3+
We love your input! We want to make contributing to this project as easy and transparent as possible.
4+
5+
## Development Setup
6+
7+
1. Fork the repo and create your branch from `main`
8+
2. Install dependencies: `npm install`
9+
3. Make your changes
10+
4. Build the project: `npm run build`
11+
5. Test your changes: `node dist/index.js --help`
12+
13+
## Code Style
14+
15+
- Use TypeScript for all new code
16+
- Follow existing code patterns
17+
- Keep functions focused and small
18+
- Add JSDoc comments for public APIs
19+
20+
## Pull Request Process
21+
22+
1. Update the README.md with details of changes if needed
23+
2. Update the package.json version following SemVer
24+
3. Create a Pull Request with a clear description
25+
26+
## Testing
27+
28+
Run the test script:
29+
```bash
30+
node test.js
31+
```
32+
33+
Test with MCP Inspector:
34+
```bash
35+
npx @modelcontextprotocol/inspector node dist/index.js
36+
```
37+
38+
## Adding New Tools
39+
40+
To add a new tool:
41+
42+
1. Create a new file in `src/tools/`
43+
2. Define the schema using Zod
44+
3. Implement the tool function
45+
4. Add the tool to `index.ts`
46+
5. Update README with documentation
47+
48+
## Reporting Bugs
49+
50+
Use GitHub Issues to report bugs. Include:
51+
- Version of the MCP server
52+
- Steps to reproduce
53+
- Expected behavior
54+
- Actual behavior
55+
- Logs if available
56+
57+
## License
58+
59+
By contributing, you agree that your contributions will be licensed under the Functional Source License v1.1 (FSL-1.1-Apache-2.0), which will convert to Apache 2.0 two years after release.

LICENSE

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
Functional Source License, Version 1.1, Apache 2.0 Future License
2+
3+
Abbreviation
4+
FSL-1.1-Apache-2.0
5+
6+
Notice
7+
Copyright 2025 TraceMachina, Inc.
8+
9+
Terms and Conditions
10+
11+
Licensor ("We")
12+
The party offering the Software under these Terms and Conditions.
13+
14+
The Software
15+
The "Software" is each version of the software that we make available under these Terms and Conditions, as indicated by our inclusion of these Terms and Conditions with the Software.
16+
17+
License Grant
18+
Subject to your compliance with this License Grant and the Patents, Redistribution and Trademark clauses below, we hereby grant you the right to use, copy, modify, create derivative works, publicly perform, publicly display and redistribute the Software for any Permitted Purpose identified below.
19+
20+
Permitted Purpose
21+
A Permitted Purpose is any purpose other than a Competing Use. A Competing Use means making the Software available to others in a commercial product or service that:
22+
23+
1. substitutes for the Software;
24+
25+
2. substitutes for any other product or service we offer using the Software that exists as of the date we make the Software available; or
26+
27+
3. offers the same or substantially similar functionality as the Software.
28+
29+
Permitted Purposes specifically include using the Software:
30+
31+
- for your internal use and access;
32+
33+
- for non-commercial education;
34+
35+
- for non-commercial research; and
36+
37+
- in connection with professional services that you provide to a licensee using the Software in accordance with these Terms and Conditions.
38+
39+
Patents
40+
To the extent your use for a Permitted Purpose would necessarily infringe our patents, the license grant above includes a license under our patents. If you make a claim against any party that the Software infringes or contributes to the infringement of any patent, then your patent license to the Software ends immediately.
41+
42+
Redistribution
43+
The Terms and Conditions apply to all copies, modifications and derivatives of the Software.
44+
45+
If you redistribute any copies, modifications or derivatives of the Software, you must include a copy of or a link to these Terms and Conditions and not remove any copyright notices provided in or with the Software.
46+
47+
Disclaimer
48+
THE SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTIES OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, TITLE OR NON-INFRINGEMENT.
49+
50+
IN NO EVENT WILL WE HAVE ANY LIABILITY TO YOU ARISING OUT OF OR RELATED TO THE SOFTWARE, INCLUDING INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES, EVEN IF WE HAVE BEEN INFORMED OF THEIR POSSIBILITY IN ADVANCE.
51+
52+
Trademarks
53+
Except for displaying the License Details and identifying us as the origin of the Software, you have no right under these Terms and Conditions to use our trademarks, trade names, service marks or product names.
54+
55+
Grant of Future License
56+
We hereby irrevocably grant you an additional license to use the Software under the Apache License, Version 2.0 that is effective on the second anniversary of the date we make the Software available. On or after that date, you may use the Software under the Apache License, Version 2.0, in which case the following will apply:
57+
58+
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
59+
60+
You may obtain a copy of the License at
61+
62+
http://www.apache.org/licenses/LICENSE-2.0
63+
64+
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

0 commit comments

Comments
 (0)