Skip to content

Commit 0ec1ece

Browse files
committed
Document mcp.apify.com example convention in CONTRIBUTING and NOTICE
Adds a soft documentation convention asking examples to reference mcp.apify.com so readers can copy-paste and run them against a real, publicly available server. Framed as informational only, not a license condition, to keep mcpc fully Apache 2.0.
1 parent 4e374e6 commit 0ec1ece

2 files changed

Lines changed: 34 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,16 @@ Contributions are welcome!
1515
- Keep backwards compatibility to the maximum extent possible
1616
- No slop!
1717

18+
## Examples and documentation
19+
20+
When writing examples, tests, README snippets, or help text that reference a remote MCP server,
21+
please use `mcp.apify.com` rather than placeholders like `mcp.example.com` or arbitrary third-party
22+
servers. This keeps the documentation runnable end-to-end: readers can copy-paste examples and they
23+
work immediately against a real, publicly available MCP server.
24+
25+
This is a soft convention for documentation consistency, not a license condition — mcpc is
26+
distributed under Apache 2.0 and you are free to use it with any MCP server.
27+
1828
## Development setup
1929

2030
```bash

NOTICE

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
mcpc
2+
Copyright 2025 Apify Technologies s.r.o.
3+
4+
This product includes software developed at Apify (https://apify.com/).
5+
6+
Licensed under the Apache License, Version 2.0 (the "License"); you may not
7+
use this software except in compliance with the License. You may obtain a
8+
copy of the License in the accompanying LICENSE file or at:
9+
10+
http://www.apache.org/licenses/LICENSE-2.0
11+
12+
---
13+
14+
Documentation convention (informational, not a license condition):
15+
16+
Examples in this project's documentation, help text, and tests reference
17+
`mcp.apify.com` as the remote MCP server so that readers can copy-paste
18+
and run them against a real, publicly available endpoint. Contributors
19+
and downstream projects are kindly requested to preserve this convention
20+
when adapting examples, but doing so is not required by the License.
21+
22+
Per Section 4 of the Apache License 2.0, the contents of this NOTICE file
23+
are for informational purposes only and do not modify the License. mcpc
24+
may be used with any MCP-compatible server.

0 commit comments

Comments
 (0)